GetSellerEvents - Call Reference - eBay Trading Web Services

GetSellerEvents

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.

Input is the user ID for the seller whose events are returned. GetSellerEvents returns zero, one, or multiple item events. You can add filters so the data returned includes only events for items that start, end, or are modified within a certain time span.

See Working with Seller Events.

GetSellerEvents Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetSellerEventsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel nodes here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector nodes here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <EndTimeFrom> dateTime </EndTimeFrom>
  <EndTimeTo> dateTime </EndTimeTo>
  <IncludeWatchCount> boolean </IncludeWatchCount>
  <ModTimeFrom> dateTime </ModTimeFrom>
  <ModTimeTo> dateTime </ModTimeTo>
  <NewItemFilter> boolean </NewItemFilter>
  <StartTimeFrom> dateTime </StartTimeFrom>
  <StartTimeTo> dateTime </StartTimeTo>
  <UserID> UserIDType (string) </UserID>
</GetSellerEventsRequest>

Argument	Type	Reqd?	Meaning
Standard Input Fields [Jump to call-specific fields]
DetailLevel	DetailLevelCodeType (repeatable)	Optional	Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Applicable values: • ReturnAll (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (Not all values in DetailLevelCodeType apply to this field.)
ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
OutputSelector	string (repeatable)	Optional	You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. See Selecting Fields to Retrieve.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.
Call-specific Input Fields
EndTimeFrom	dateTime	Conditional	Describes the earliest (oldest) date to use in a date 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 correspoding 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.
EndTimeTo	dateTime	Optional	Describes the latest (most recent) date to use in a date 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.
IncludeWatchCount	boolean	Optional	Specifies whether to include WatchCount in Item nodes returned. WatchCount is the number of watches buyers have placed on the item from their My eBay accounts.
ModTimeFrom	dateTime	Conditional	Describes the earliest (oldest) date to use in a date 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 correspoding 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 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.
ModTimeTo	dateTime	Optional	Describes the latest (most recent) date to use in a date 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.
NewItemFilter	boolean	Optional	Specifies that only new items are to be returned. NewItemFilter is an optional input.
StartTimeFrom	dateTime	Conditional	Describes the earliest (oldest) date to use in a date 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 correspoding 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.
StartTimeTo	dateTime	Optional	Describes the latest (most recent) date to use in a date 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.
UserID	UserIDType (string)	Optional	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 that 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. See Working with Anonymous User Informationin the eBay Web Services Guide for more information.

GetSellerEvents Output

The box below lists all fields that might be returned in the call response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetSellerEventsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <ItemArray> ItemArrayType 
    <Item> ItemType 
      <BestOfferDetails> BestOfferDetailsType 
        <BestOfferEnabled> boolean </BestOfferEnabled>
      </BestOfferDetails>
      <BuyItNowPrice> AmountType (double) </BuyItNowPrice>
      <Currency> CurrencyCodeType </Currency>
      <HitCount> long </HitCount>
      <HitCounter> HitCounterCodeType </HitCounter>
      <ItemID> ItemIDType (string) </ItemID>
      <ListingDetails> ListingDetailsType 
        <EndTime> dateTime </EndTime>
        <StartTime> dateTime </StartTime>
      </ListingDetails>
      <ListingType> ListingTypeCodeType </ListingType>
      <Quantity> int </Quantity>
      <SellerVacationNote> string </SellerVacationNote>
      <SellingStatus> SellingStatusType 
        <BidCount> int </BidCount>
        <CurrentPrice> AmountType (double) </CurrentPrice>
        <HighBidder> UserType 
          <Email> string </Email>
          <FeedbackScore> int </FeedbackScore>
          <UserAnonymized> boolean </UserAnonymized>
          <UserID> UserIDType (string) </UserID>
        </HighBidder>
        <ListingStatus> ListingStatusCodeType </ListingStatus>
        <QuantitySold> int </QuantitySold>
      </SellingStatus>
      <Site> SiteCodeType </Site>
      <Title> string </Title>
      <WatchCount> long </WatchCount>
    </Item>
    <!-- ... more Item nodes here ... -->
  </ItemArray>
  <TimeTo> dateTime </TimeTo>
</GetSellerEventsResponse>

Return Value	Type	Returned?	Meaning
Standard Output Fields [Jump to call-specific fields]
Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType (repeatable)	Conditionally	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
Errors.ErrorParameters	ErrorParameterType (repeatable)	Conditionally	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
ItemArray	ItemArrayType	Always	Collection of Item objects, each of which represents an item listing that incurred the type of seller event change specified in the call's inputs. Returns empty if the seller has no item events within the time window indicated in the request. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item	ItemType (repeatable)	Conditionally	Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request. Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has a transactional relationship with that buyer. For calls that support detail levels, the set of fields returned is also controlled by the value of DetailLevel in the request. For some calls, other parameters in the request can also control the data returned for each item. For example, GranularityLevel controls the fields to return for each item in the GetSellerList response. For GetSearchResultsExpress, ItemDetails controls the fields to return for each item. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item .BestOfferDetails	BestOfferDetailsType	Conditionally	Container for BestOffer properties associated with the item. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item .BestOfferDetails .BestOfferEnabled	boolean	Conditionally	Whether best offer is enabled for this item. A seller of a fixed price format item (in a category for which Best Offer is also enabled) can opt that item into the Best Offer feature. This feature enables a buyer to make a lower priced binding offer on that item. If a listing has no active best offers, you can change this value (true to false, and vice versa). If a listing does have active best offers, you cannot change the value to false. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.BuyItNowPrice	AmountType (double)	Conditionally	For Chinese auction listings, Buy It Now allows a user to purchase the item at a fixed price and end the auction immediately. Use this field to add Buy It Now and specify the amount a buyer would need to bid to take advantage of the Buy It Now feature. On the main eBay site, not applicable to fixed-price items (ListingType values StoresFixedPrice or FixedPriceItem), AdFormat listings, or Half.com listings. For fixed-price and Half.com listings, see StartPrice instead. See the eBay Web Services Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing. Once a Chinese auction has bids (and the high bid exceeds the reserve price, if any), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that the seller originally set for the listing. You can use Item.SellingStatus.BidCount to determine whether an auction with Buy It Now has bids or not. With GetSearchResults, you can use the Item.SearchDetails.BuyItNowEnabled flag to determine whether the item can still be purchased using Buy It Now. With GetItem, you can use the Item.ListingDetails.BuyItNowAvailable flag to determine whether the item can still be purchased using Buy It Now. On some sites, the Buy It Now price for a Chinese auction may remain available for certain categories even after a bid is placed. See the "Longer Lasting Buy It Now" link below for more details and the latest list of eBay US categories that support this behavior. The eBay Spain site supports this behavior for all categories. For a listing to be eligible for Express, the max Buy It Now Price is USD 10,000.00 for the US. (Additional price limits may be imposed by the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation, as they may vary for each user.) To remove this value when revising or relisting an item, use DeletedField. DetailLevel: ReturnAll. See: Longer Lasting Buy It Now Specify a Fixed Price for Express and eBay Revising US eBay Motors Listings
ItemArray.Item.Currency	CurrencyCodeType	Conditionally	Currency associated with the item's price information. 3-letter ISO 4217 currency code that corresponds to the site specified in the item-listing request. Also applicable as input to AddItem and related calls when you list items to Half.com (specify USD). You cannot modify a listing's currency when you revise or relist an item. Applicable values: See Currency. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Field Differences for eBay Sites.
ItemArray.Item.HitCount	long	Conditionally	The number of page views for the item. This number is calculated by eBay and cannot be set via the API. Returned if the hit counter type is BasicStyle, RetroStyle, or HiddenStyle. For HiddenStyle, HitCount is returned only if the requestor is the item's seller. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.HitCounter	HitCounterCodeType	Always	Indicates whether an optional hit counter is displayed on the item's listing page and, if so, what type. See HitCounterCodeType for specific values. Not applicable to Half.com. This field is ignored when Item.ListingType=Express. Applicable values: • BasicStyle (in/out) A basic style hit counter. • CustomCode (in/out) Reserved for internal or future use • GreenLED (in/out) A green LED, computer-style hit counter (US only). Non-US sites will return errors if they use GreenLED as input, and should use RetroStyle instead. • Hidden (in/out) A hidden hit counter (US only). The number of page views will only be available to the item's seller. For faster "View Item" page loads, use HiddenStyle. • HiddenStyle (in/out) A hidden hit counter. The number of page views will only be available to the item's seller. • HonestyStyle (in/out) A basic style hit counter (US only). Non-US sites will return errors if they use HonestyStyle as input, and should use BasicStyle instead. • NoHitCounter (in/out) No hit counter. The number of page views will not be available. • RetroStyle (in/out) A retro, computer-style hit counter. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ItemID	ItemIDType (string)	Conditionally	The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResultsExpress, always returned when ItemArray.Item is returned. For GetCart/SetCart input, this is only required if the parent container is submitted. Max length: 19. (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits.). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ListingDetails	ListingDetailsType	Conditionally	Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self- closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ListingDetails .EndTime	dateTime	Conditionally	Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended. In GetSearchResults, for StoresFixedPrice items which are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. The discrepancy is intended to facilitate renewal every 30 days of such items' end times. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ListingDetails .StartTime	dateTime	Conditionally	The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. The StartTime value returned by search calls such as GetSearchResults and GetCategoryListings may vary from the value returned by GetItem. The time value is the same value in the following: The StartTime value returned by GetSearchResults, the StartTime value returned by GetCategoryListings, and the time the item became available for search on the eBay site. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ListingType	ListingTypeCodeType	Conditionally	The format of the listing the seller wants to use, such as Chinese auction or fixed price. Optional for eBay.com listings (defaults to Chinese) in AddItem and VerifyAddItem. On the US, Germany, and UK sites, eligible items listed in the fixed price, Store Inventory, or (for the US) in the Chinese auction format with Buy It Now are also included on eBay Express. Express Germany and UK also support an Express format for listing only on Express. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • Dutch (in/out) Multiple-quantity online auction format. A Dutch auction has a Quantity greater than 1. Buyers engage in competitive bidding. Some sites also offer Buy It Now for Dutch auctions. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • Express Deprecated as of version 561. (in/out) For Germany only: eBay Express format (item is listed only on eBay Express only, not on eBay). You must be an Express Germany seller to use this format. See "Express Format Criteria" in the eBay Web Services guide. Starting in late April, this value will no longer work, regardless of the API version you are using. Deprecation version: 561. See also Deprecated Objects. • FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Starting in early June 2008, on the Italy site, stores fixed price items will be treated as basic fixed-price items. On the Italy site, permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • Live (out) Live auction, on-site auction that can include non-eBay bidders. (Use AddLiveAuctionItem to list live auctions.) Live auctions are listed on the eBay Live Auctions site, in live auction categories. They can also appear on eBay if the seller lists the lot in a secondary category that is an eBay category. • PersonalOffer (out) Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • StoresFixedPrice (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Starting in early June 2008, on the Italy site, stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. See: Different Ways of Selling Listing Types (Formats) GetCategoryFeatures Fees per Site Listing Criteria for eBay Express
ItemArray.Item.Quantity	int	Conditionally	For AddItem and related calls, this is the number of items in the listing. For new listings being defined, this is the initial number of items the seller offers for sale. Even during a Dutch auction, where one of several items can be purchased during the auction, this number does not change. Sellers need to meet certain feedback requirements to specify a quantity greater than 1. When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller. For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1. For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item .SellerVacationNote	string	Conditionally	The seller is on vacation (as determined by the seller's store preferences) in two cases: i.) the item is a Store Inventory item and the seller has chosen to hide Store Inventory items while on vacation, and ii.) the seller has chosen to add a message to listed items while on vacation. Not applicable to Half.com. DetailLevel: ReturnAll.
ItemArray.Item.SellingStatus	SellingStatusType	Always	Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. For GetSearchResultsExpress, this is always returned when ItemArray.Item is returned. Returned by GetCart/SetCart only if there are items in the cart. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.SellingStatus .BidCount	int	Conditionally	Number of bids placed so far against the item. Only applicable to competitive-bidding listings (Chinese and Dutch auctions). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.SellingStatus .CurrentPrice	AmountType (double)	Conditionally	For competitive-bidding listings (Chinese and Dutch auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. For GetSearchResultsExpress, this is the current fixed price of the listing, and it is always returned when ItemArray.Item is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.SellingStatus .HighBidder	UserType	Conditionally	For single-item (Quantity = 1) auction listings that have ended and have a winning bidder, indicates the user who is the high bidder. For single-item basic fixed price (FixedPriceItem) or Store Inventory (StoresFixedPrice) listings that have ended, indicates the user who purchased the item. Not returned for auctions that have received no bids, fixed price and Store Inventory listings that are still active, or any multi-item (Quantity > 1) listings. In the case of the PlaceOffer response, the current high bidder. DetailLevel: ReturnAll.
ItemArray.Item.SellingStatus .HighBidder.Email	string	Conditionally	Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. Based on Trust and Safety policies, the time is unspecified and can vary by site. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. See Working with Anonymous User Information.
ItemArray.Item.SellingStatus .HighBidder.FeedbackScore	int	Conditionally	The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. To be eligible to list on Express, a seller's feedback score needs to be 100 or higher. See "eBay Express" in the eBay Web Services guide. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. DetailLevel: ReturnAll. See Working with Anonymous User Information.
ItemArray.Item.SellingStatus .HighBidder.UserAnonymized	boolean	Always	Indicates whether or not the User container has been made anonymous. If true, some elements in the User container have either been removed, or had their values changed to remove identifying characteristics. If false, all expected elements are returned, and no values are changed. Since a bidder's user info is anonymous, this tag is returned as false only to the bidder, and to the seller of an item that the user is bidding on. For all other users, this tag is returned as true. See Working with Anonymous User Information.
ItemArray.Item.SellingStatus .HighBidder.UserID	UserIDType (string)	Conditionally	Unique eBay user ID for the user. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. Since a bidder's user info is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a**b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "IA". Note that in this format, the anonymous bidder ID stays the same for every auction. (GetMyeBayBuying only) when bidding on items listed on the US site: UserID is replaced with the value "ab" where a and b are random characters from the UserID. When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". (GetMyeBayBuying only) when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". (GetSearchResults only)When IncludeFeedback is set to true in GetSearchResults request, the call response returns the seller's User ID. Please note seller's UserID is not anonymized. DetailLevel:** ReturnAll. See Working with Anonymous User Information.
ItemArray.Item.SellingStatus .ListingStatus	ListingStatusCodeType	Conditionally	Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing. Applicable values: • Active (out) The listing is still active or the listing has ended with a sale but eBay has not completed processing the sale details (e.g., total price and high bidder). A multi-item listing is considered active until all items have winning bids or purchases or the listing ends with at least one winning bid or purchase. If the listing has ended with a sale but this Active status is returned, please allow several minutes for eBay to finish processing the listing. • Completed (out) The listing has closed and eBay has completed processing the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. Although the Final Value Fee for FixedPriceItem, StoresFixedPrice, and Buy It Now Dutch listing types is returned by GetSellerTransactions and GetItemTransactions on a transaction by transaction basis, all other listing types, including Chinese and Dutch (no Buy It Now purchases), require the listing status to be Completed before the Final Value Fee is returned. • Custom (out) Reserved for internal or future use. • CustomCode (out) Reserved for internal or future use. • Ended (out) The listing has ended. If the listing ended with a sale, eBay has completed processing of the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. However, the final value fee is not yet available. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.SellingStatus .QuantitySold	int	Conditionally	Number of items purchased so far. (Subtract from the value returned in the Item.Quantity field to calculate the number of items remaining.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.Site	SiteCodeType	Conditionally	The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases (such as with listings on eBay Express), the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing. When you specify Item.Site in AddItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API). Not applicable to Half.com. For eBay Live Auctions, pass a value of US. Applicable values: See Site. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See: The US and International eBay Sites Specifying the Target Site Field Differences for eBay Sites Seller Criteria for eBay Express
ItemArray.Item.Title	string	Conditionally	Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetSearchResultsExpress, always returned when ItemArray.Item is returned. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.WatchCount	long	Conditionally	The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. DetailLevel: ReturnAll.
TimeTo	dateTime	Always	Indicates the latest (most recent) date for any date-based filtering specified as input. Specifically, this field contains the value you specified in the StartTimeTo, EndTimeTo, or ModTimeTo filter, if you used a time filter in the request. If no time filter was specified, TimeTo returns the current time. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

GetSellerEvents Detail Controls

Detail Control: DetailLevel

The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)

none	The field is returned if DetailLevel is not specified on input.
Y	The field is always returned.
(Y)	The field is conditionally returned. See the field description for clarification of conditions.

Output Field	ReturnAll	none
ItemArray	Y	Y
ItemArray.Item	(Y)	(Y)
ItemArray.Item.BestOfferDetails	(Y)	(Y)
ItemArray.Item.BestOfferDetails.BestOfferEnabled	(Y)	(Y)
ItemArray.Item.BuyItNowPrice	(Y)	-
ItemArray.Item.Currency	(Y)	(Y)
ItemArray.Item.HitCount	(Y)	(Y)
ItemArray.Item.HitCounter	Y	Y
ItemArray.Item.ItemID	(Y)	(Y)
ItemArray.Item.ListingDetails	(Y)	(Y)
ItemArray.Item.ListingDetails.EndTime	(Y)	(Y)
ItemArray.Item.ListingDetails.StartTime	(Y)	(Y)
ItemArray.Item.ListingType	(Y)	-
ItemArray.Item.Quantity	(Y)	(Y)
ItemArray.Item.SellerVacationNote	(Y)	-
ItemArray.Item.SellingStatus	Y	Y
ItemArray.Item.SellingStatus.BidCount	(Y)	(Y)
ItemArray.Item.SellingStatus.CurrentPrice	(Y)	(Y)
ItemArray.Item.SellingStatus.HighBidder	(Y)	-
ItemArray.Item.SellingStatus.HighBidder.Email	(Y)	-
ItemArray.Item.SellingStatus.HighBidder.FeedbackScore	(Y)	-
ItemArray.Item.SellingStatus.HighBidder.UserID	(Y)	-
ItemArray.Item.SellingStatus.ListingStatus	(Y)	(Y)
ItemArray.Item.SellingStatus.QuantitySold	(Y)	(Y)
ItemArray.Item.Site	(Y)	(Y)
ItemArray.Item.Title	(Y)	(Y)
ItemArray.Item.WatchCount	(Y)	-
TimeTo	Y	Y

GetSellerEvents Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetSellerEvents.

GetSellerEvents Change History

Version	Description
561 2008-04-16	Item.ListingType.Express (deprecated): Due to the shutdown of UK and Germany eBay Express sites Item.ListingType.Express has been deprecated.
555 2008-03-05	GetSellerEventsRequestType.UserIDType (modified): Note that 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. See Working with Anonymous User Informationin the eBay Web Services Guide for more information.
491 2006-12-13	UserType (modified): Starting Jan 2007, selected tags in the User container will be made anonymous for listings that have a current price of $200.00 USD or higher. See Working with Anonymous User Information for a list of effected fields.
453 2006-03-22	ItemType.BestOfferEnabled (added): Indicates, when true, that an item is available through the Best Offer feature.
447 2006-02-08	TotalAvailable (modified): Previously announced as obsolete for this call.
431 2005-10-19	GetSellerEvents.TotalAvailable (modified): This field is obsolete (not returned) as of API version 427.
427 2005-09-21	Item.SellingStatus.ListingStatus (added): Specifies an active or ended listing's status in eBay's processing workflow. For items that have sold, this to determine whether eBay has finished processing total price, winning bidder/buyer, and Final Value Fee details.
425 2005-09-07	IncludeWatchCount (added): New input argument.

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

eBay Trading API Call Reference Version 579

eBay Trading API
Call Reference Version 579