GetSellerEvents

Use this call to retrieve a list of the items on which a seller event has occurred. A seller event includes actions such as a revision to the item (e.g., a description change), a price change (through a bid), or the ending of an item's listing.

GetSellerEvents returns individual item data in an ItemArray object. Item data is retrieved for only the authenticated user of the call. GetSellerEvents returns zero or more items, depending on the items that have seller events within the specified time range. You can add filters so the data returned includes only items that start, end, or are modified within a certain time span.

Request Details

Each of the date-range filters is individually optional, but a given call to GetSellerEvents must use at least one date-range filter. Multiple date-range filters may not be used in the same call.

Working With the Response

GetSellerEvents returns a list of the sellers event items into an ItemArray container. The Quantity element is only returned if it was set by the seller or by eBay.

An application might process the response in the following sequence:

  1. Traverse the collection to visit each Item object contained in the ItemArray container.
  2. Inspect the properties of each Item object to get the desired values for the listing.
  3. As applicable for the application, store the appropriate item data. If data for the same listing is already stored, update it with the new data. Comparing the new incoming data for a listing with the previously stored data allows the application to indicate to the seller what information has changed.

Best Practices

See the following FAQ for extra details: Best Practices for GetSellerEvents and GetSellerTransactions

Testing GetSellerEvents

Test GetSellerEvents in the Sandbox as follows:

  1. Register a Sandbox user (seller) and add at two or three new items for the test seller using AddItem.
  2. Some data values are returned only if the call requestor is the item seller. To test the call from the perspective of another user, execute the call using a Sandbox test user other than the one used to list the item.
  3. Use a second and third Sandbox test user to perform actions that translate into seller events, such as bidding on a Chinese auction. (The seller of an item cannot bid on his or her own item, a rule that is also enforced in the Sandbox.)
  4. For applications that create and use competitive-bid item listings (Chinese auctions), bid on the items using the Sandbox user interface before retrieving the item using GetSellerEvents. This will populate the high bidder data for items in the result set.

Related Information

See Working with Seller Events.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetSellerEvents User Notes

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 does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls). 

<?xml version="1.0" encoding="utf-8"?>
<GetSellerEventsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <EndTimeFrom> dateTime </EndTimeFrom>
  <EndTimeTo> dateTime </EndTimeTo>
  <HideVariations> boolean </HideVariations>
  <IncludeVariationSpecifics> boolean </IncludeVariationSpecifics>
  <IncludeWatchCount> boolean </IncludeWatchCount>
  <ModTimeFrom> dateTime </ModTimeFrom>
  <ModTimeTo> dateTime </ModTimeTo>
  <NewItemFilter> boolean </NewItemFilter>
  <StartTimeFrom> dateTime </StartTimeFrom>
  <StartTimeTo> dateTime </StartTimeTo>
  <UserID> UserIDType (string) </UserID>
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel values allowed here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector values allowed here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetSellerEventsRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
EndTimeFrom dateTime Conditional 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 correspoding 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).

See KB article: Best Practices for GetSellerEvents and GetSellerTransactions.
EndTimeTo dateTime Optional 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.
HideVariations boolean Optional Specifies whether to force the response to hide variation details for multi-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.
Default: false.
IncludeVariationSpecifics boolean Optional Specifies whether to force the response to include variation specifics for multi-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=true.

Please note that 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 EndTime, StartTime, or ModTime filters.
Default: false.
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 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 correspoding 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.

See KB article: Best Practices for GetSellerEvents and GetSellerTransactions.
ModTimeTo dateTime Optional 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.
NewItemFilter boolean Optional Default is true. If true, response includes only items that have been modified within the ModTime range. If false, response includes all items.
StartTimeFrom dateTime Conditional 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 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 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).

See KB article: Best Practices for GetSellerEvents and GetSellerTransactions.
StartTimeTo dateTime Optional 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.
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 Information.
Standard Input Fields  
DetailLevel DetailLevelCodeType Optional,
repeatable: [0..*]		 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 Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is 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 Optional,
repeatable: [0..*]		 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:
    Routing the Request (Gateway URLs)
    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.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetSellerEvents User Notes

GetSellerEvents Output

The box below lists all fields that might be returned in the 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).

<?xml version="1.0" encoding="utf-8"?>
<GetSellerEventsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <ItemArray> ItemArrayType
    <Item> ItemType
      <BestOfferDetails> BestOfferDetailsType
        <BestOfferCount> int </BestOfferCount>
        <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>
      <SellerProfiles> SellerProfilesType
        <SellerPaymentProfile> SellerPaymentProfileType
          <PaymentProfileName> string </PaymentProfileName>
        </SellerPaymentProfile>
        <SellerReturnProfile> SellerReturnProfileType
          <ReturnProfileID> long </ReturnProfileID>
          <ReturnProfileName> string </ReturnProfileName>
        </SellerReturnProfile>
        <SellerShippingProfile> SellerShippingProfileType
          <ShippingProfileID> long </ShippingProfileID>
          <ShippingProfileName> string </ShippingProfileName>
        </SellerShippingProfile>
      </SellerProfiles>
      <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>
      <ShippingPackageDetails> ShipPackageDetailsType
      </ShippingPackageDetails>
      <Site> SiteCodeType </Site>
      <Title> string </Title>
      <Variations> VariationsType
        <Variation> VariationType
          <Quantity> int </Quantity>
          <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>
          <SKU> SKUType (string) </SKU>
          <StartPrice> AmountType (double) </StartPrice>
          <VariationSpecifics> NameValueListArrayType
            <NameValueList> NameValueListType
              <Name> string </Name>
              <Value> string </Value>
              <!-- ... more Value values allowed here ... -->
            </NameValueList>
            <!-- ... more NameValueList nodes allowed here ... -->
          </VariationSpecifics>
          <!-- ... more VariationSpecifics nodes allowed here ... -->
        </Variation>
        <!-- ... more Variation nodes allowed here ... -->
      </Variations>
      <WatchCount> long </WatchCount>
    </Item>
    <!-- ... more Item nodes allowed here ... -->
  </ItemArray>
  <TimeTo> dateTime </TimeTo>
  <!-- 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 allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetSellerEventsResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
ItemArray ItemArrayType Always 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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See KB article: Best Practices for GetSellerEvents and GetSellerTransactions.
ItemArray.Item ItemType Conditionally,
repeatable: [0..3000]		 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 an order 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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .BestOfferDetails 		BestOfferDetailsType Conditionally For Add/Revise/Relist/Verify calls: This container is used to enable the Best Offer feature on a listing. The Best Offer feature is not available for auction listings.

For GetItem and other calls that retrieve item data, this container will include the status (GetMyeBayBuying only) and dollar amount of the latest Best Offer on a fixed-price listing, and the number of Best Offers received for the fixed-price listing.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .BestOfferDetails
  .BestOfferCount 		int Conditionally The number of Best Offers made for this item, if any. In other words, if there are no Best Offers made, this container will not appear in the response.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .BestOfferDetails
  .BestOfferEnabled 		boolean Conditionally This field indicates whether or not the Best Offer feature is enabled for this item. A seller of a fixed-price 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 an active Best Offer, 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 auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing.

There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid.

This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings.

Once an auction has bids (and the high bid exceeds the Reserve Price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not.

There might be price limits imposed for Buy It Now items, subject to 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 because they can vary for each user.

To remove this value when revising or relisting an item, use DeletedField.

DetailLevel: ReturnAll.

See:
    Listing Policies
    Revising Items

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 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.

To see the list of currently supported currency codes, call GeteBayDetails with DetailName set to CurrencyDetails, and then look for the CurrencyDetails.Currency fields in the response.

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.

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 order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and TransactionID to uniquely identify an order line item. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.)

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.
Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base.
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.

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.

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 auction style or fixed price.

Optional for eBay.com listings (defaults to auction style) in AddItem and VerifyAddItem. 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 in 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.

•   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 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. Stores fixed price items will be treated as basic fixed-price items. 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).

•   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.


(Not all values in ListingTypeCodeType apply to this field.)


DetailLevel: ReturnAll.

See:
    Different Ways of Selling
    Basic Building Blocks
    GetCategoryFeatures
    Fees per Site

ItemArray.Item.Quantity int Conditionally The value indicates the quantity of items available for purchase in the listing. This field is required for all auction listings and for non-variation, fixed-price listings. For auction listings, this value is always '1'. For a non-variation, fixed-price listing, the Item.Quantity value indicates the number of identical items the seller has available for purchase in the listing.

For AddFixedPriceItem, VerifyAddFixedPriceItem, RelistFixedPriceItem, and ReviseFixedPriceItem: in a multi-variation, fixed-price listing, the Item.Quantity should not be used; instead, the quantity of each variation is specified in the Variation.Variation.Quantity field instead. See the Creating a listing with variations eBay Help page for more information on variations.

For RelistItem and RelistFixedPriceItem: Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was 10, and 3 items have been sold, eBay sets the relisted item's Quantity to 10 by default, and not 7. So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests.

When eBay auto-renews a GTC listing (ListingDuration=GTC) on your behalf, eBay relists with correct quantity available.

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below.
For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1.

For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change.

For order line item calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold).

For GetDispute: Quantity is the number of items being raised in the dispute.

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.

See:
    Listing Policies
    Selecting a Selling Format

ItemArray.Item.SellerProfiles SellerProfilesType Conditionally Root container consisting of references to one or more Business Policies profiles. Exactly one Payment Profile, one Shipping Profile, and one Return Policy Profile may be applied to the listing.
ItemArray.Item.SellerProfiles
  .SellerPaymentProfile 		SellerPaymentProfileType Conditionally The SellerPaymentProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address.

Business Policies payment profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data.
ItemArray.Item.SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileName 		string Conditionally The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

In the "Get" calls, the PaymentProfileID value will always be returned if the listing is using a Business Policies payment profile, and the PaymentProfileName value will be returned if a name is assigned to the payment profile.
ItemArray.Item.SellerProfiles
  .SellerReturnProfile 		SellerReturnProfileType Conditionally The SellerReturnProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies return policy profile. Business Policies return policy profiles contain detailed information on the seller's return policy, including the refund option, how many days the buyer has to return the item for a refund, warranty information, and restocking fee (if any).

Business Policies return policy profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data.
ItemArray.Item.SellerProfiles
  .SellerReturnProfile
  .ReturnProfileID 		long Conditionally The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

In the "Get" calls, the ReturnProfileID value will always be returned if the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile.
ItemArray.Item.SellerProfiles
  .SellerReturnProfile
  .ReturnProfileName 		string Conditionally The name of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

In the "Get" calls, the ReturnProfileID value will always be returned if the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile.
ItemArray.Item.SellerProfiles
  .SellerShippingProfile 		SellerShippingProfileType Conditionally The SellerShippingProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies shipping policy profile. Business Policies shipping profiles contain detailed information on domestic and international shipping, including shipping service options, handling time, package handling costs, excluded ship-to locations, and shipping insurance information.

Business Policies shipping profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data.
ItemArray.Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileID 		long Conditionally The unique identifier of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. If both fields are provided and their values don't match, the ShippingProfileID takes precedence.

In the "Get" calls, the ShippingProfileID value will always be returned if the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile.
ItemArray.Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileName 		string Conditionally The name of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. If both fields are provided and their values don't match, the ShippingProfileID takes precedence.

In the "Get" calls, the ShippingProfileID value will always be returned if the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile.
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.

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 auction item.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.SellingStatus
  .CurrentPrice 		AmountType (double) Conditionally The current price of the item in the original listing currency.

For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price.

For fixed-price and ad format listings, this is the current listing price.

In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.SellingStatus
  .HighBidder 		UserType Conditionally For ended auction listings that have a winning bidder, this field is a container for the high bidder's user ID. For ended, single-item, fixed-price listings, this field is a container for the user ID of the purchaser. This field isn't returned for auctions with no bids, or for active fixed-price listings, or for active Store Inventory listings. In the case of PlaceOffer, for auction listings, this field is a container for the high bidder's user ID. In the PlaceOffer response, the following applies: For multiple-quantity, fixed-price listings, the high bidder is only returned if there is just one order line item (or only for the first order line item that is created).

DetailLevel: ReturnAll.
ItemArray.Item.SellingStatus
  .HighBidder.Email 		string Conditionally Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) 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.

For the order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request.
Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field .

DetailLevel: ReturnAll.

See:
    Working with Anonymous User Information
    Static Email Addresses in Trading API Calls

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 either side of an order. Each order line item 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.

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.

Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules:

When bidding on items, 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, "I****A".

Note that in this format, the anonymous bidder ID can change for each auction.

For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the Philippines site: 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 Philippines site 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".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

For PlaceOffer, see also SellingStatus.HighBidder.

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 (FVF) for FixedPriceItem and StoresFixedPrice items is returned by GetSellerTransactions and GetItemTransactions, all other listing types (excluding 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 The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item.

For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item.
In multi-variation listings, this value matches total quantity sold across all variations.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .ShippingPackageDetails 		ShipPackageDetailsType Conditionally Container consisting of dimension and size details related to a shipping package in which an item will be sent. The information in this container is applicable if the seller is using calculated shipping or flat rate shipping using shipping rate tables with weight surcharges. This container is only returned in the "Get" calls if specified for the item.
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, and other information. In some cases, 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 or AddFixedPriceItem, 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.

Applicable values: See Site.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    eBay Sites and Environments
    Standard Data for All Calls
    Field Differences for eBay Sites

ItemArray.Item.Title string Conditionally Name of the item as it appears in the listing or search results. Title is required for most items. This field is only optional if you leverage Pre-filled Item Information by using the Item.ProductListingDetails or Item.ExternalProductID containers.

You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.)

For the AddItem family of calls: Not applicable to Half.com.

For ReviseItem and ReviseFixedPriceItem You can only add or change the item title if the listing has no bids (for auctions) or sales (for fixed-price listings) and the listing does not end within 12 hours.

For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations.
Max length: 80.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.Variations VariationsType Conditionally Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one order line item can contain multiple items from a single variation.)

If you list in two categories, both categories must support listing with variations. See VariationsEnabled in GetCategoryFeatures to determine applicable categories.

For ReviseFixedPriceItem and RelistFixedPriceItem: Once a listing has been submitted with variations, you can't delete all the variations when you revise or relist the listing (because it would be considered a different listing). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no purchases, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0.

As a best practice, if you want to revise multiple variations in the same listing at the same time (i.e, within a very short period), use a single ReviseFixedPriceItem request and include all the variation revisions in the same request. If your application design requires you to revise each variation individually, then avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing.

For GetItem and related calls Only returned when a listing has variations.

For GetSellerList: Only returned when a listing has variations, IncludeVariations was set to true in the request, the DetailLevel was set to ReturnAll, and an applicable pagination value and time range were specified.

For GetItemTransactions Only returned in Item when a listing has variations and IncludeVariations was set to true in the request. (Also see Variation returned in Transaction for information about which variation was actually purchased.)

For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling: Only returned when a listing has variations and HideVariations was set to false or not specified in the request.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Multi-Variation Listings.
ItemArray.Item.Variations
  .Variation 		VariationType Conditionally,
repeatable: [0..*]		 Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes.

When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers.

When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0.

Variation, Pictures, or ModifyNameList (or all) need to be specified when the Variations node is specified in listing requests.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Multi-Variation Listings.
ItemArray.Item.Variations
  .Variation.Quantity 		int Conditionally This value indicates the quantity of items in the specific variation that are available for purchase. If you set Variation.Quantity to '0' when you create, revise, or relist an item listing, the variation is dropped from the listing.

For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total number of items associated with the variation, including the quantity available and the quantity sold. To calculate the quantity available for sale, subtract SellingStatus.QuantitySold from this value.

For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing.

For GetSellerTransactions: See Item.Quantity instead.

See the Trading API Guide for more details about setting and modifying a variation's quantity.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Describing Variations in a Listing.
ItemArray.Item.Variations
  .Variation.SellingStatus 		SellingStatusType Conditionally Contains the variation's quantity sold. Always returned when variations are present.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .BidCount 		int Conditionally Number of bids placed so far against the auction item.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .CurrentPrice 		AmountType (double) Conditionally The current price of the item in the original listing currency.

For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price.

For fixed-price and ad format listings, this is the current listing price.

In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder 		UserType Conditionally For ended auction listings that have a winning bidder, this field is a container for the high bidder's user ID. For ended, single-item, fixed-price listings, this field is a container for the user ID of the purchaser. This field isn't returned for auctions with no bids, or for active fixed-price listings, or for active Store Inventory listings. In the case of PlaceOffer, for auction listings, this field is a container for the high bidder's user ID. In the PlaceOffer response, the following applies: For multiple-quantity, fixed-price listings, the high bidder is only returned if there is just one order line item (or only for the first order line item that is created).

DetailLevel: ReturnAll.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.Email 		string Conditionally Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) 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.

For the order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request.
Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field .

DetailLevel: ReturnAll.

See:
    Working with Anonymous User Information
    Static Email Addresses in Trading API Calls

ItemArray.Item.Variations
  .Variation.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 either side of an order. Each order line item 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.

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.Variations
  .Variation.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.Variations
  .Variation.SellingStatus
  .HighBidder.UserID 		UserIDType (string) Conditionally Unique eBay user ID for the user.

Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules:

When bidding on items, 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, "I****A".

Note that in this format, the anonymous bidder ID can change for each auction.

For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the Philippines site: 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 Philippines site 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".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

For PlaceOffer, see also SellingStatus.HighBidder.

DetailLevel: ReturnAll.

See Working with Anonymous User Information.
ItemArray.Item.Variations
  .Variation.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 (FVF) for FixedPriceItem and StoresFixedPrice items is returned by GetSellerTransactions and GetItemTransactions, all other listing types (excluding 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.Variations
  .Variation.SellingStatus
  .QuantitySold 		int Conditionally The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item.

For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item.
In multi-variation listings, this value matches total quantity sold across all variations.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.Variations
  .Variation.SKU 		SKUType (string) Conditionally A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding order line items. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.)

If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU.

If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings.

For GetItem and related calls: Only returned if the seller specified a SKU for the variation.
Max length: 80.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Describing Variations in a Listing.
ItemArray.Item.Variations
  .Variation.StartPrice 		AmountType (double) Conditionally The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations.

You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Describing Variations in a Listing.
ItemArray.Item.Variations
  .Variation.VariationSpecifics 		NameValueListArrayType Conditionally,
repeatable: [2..5]		 A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values.

When you revise a listing that includes variations, you can change names in variation specifics by using ModifyNameList. You can also add, delete, or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (order line items). If the variation has sales, then set the Quantity to 0.

For GetSellerEvents To keep the GetSellerEvents response smaller, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Describing Variations in a Listing
    Revising and Relisting with Variations

ItemArray.Item.Variations
  .Variation.VariationSpecifics
  .NameValueList 		NameValueListType Conditionally,
repeatable: [0..*]		 For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified.

For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node.

If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node.

When you list with Item Variations:
a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
b) Specify up to five VariationSpecifics in each Variation node.
c) Specify all applicable names with all their supported values in the VariationSpecificSet node.

See the Variation sample in the AddFixedPriceItem call reference for examples.

For PlaceOffer: Required if the item being purchased includes Item Variations.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.Variations
  .Variation.VariationSpecifics
  .NameValueList.Name 		string Conditionally A name in a name/value pair.

For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing.

For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations.

For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer").

For PlaceOffer: Required if the item being purchased includes Item Variations.
Max length: 40.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.Variations
  .Variation.VariationSpecifics
  .NameValueList.Value 		string Conditionally,
repeatable: [0..*]		 A value associated with the name.

For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values.

For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values.

In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing.

For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available.

For PlaceOffer: Required if the item being purchased includes Item Variations.
Max length: 50.

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.
Standard Output 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 Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is 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 Conditionally,
repeatable: [0..*]		 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. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]		 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 and other Trading API calls 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.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetSellerEvents User Notes

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.)

The none column indicates the fields that are returned when you do not specify a DetailLevel.

YThe field is always returned.
(Y)The field is conditionally returned. See the field documentation for clarification of conditions.
-The field is not returned.

Output Field none ReturnAll
ItemArrayYY
ItemArray.Item(Y)(Y)
ItemArray.Item.BestOfferDetails(Y)(Y)
ItemArray.Item.BestOfferDetails.BestOfferCount(Y)(Y)
ItemArray.Item.BestOfferDetails.BestOfferEnabled(Y)(Y)
ItemArray.Item.BuyItNowPrice-(Y)
ItemArray.Item.Currency(Y)(Y)
ItemArray.Item.HitCount(Y)(Y)
ItemArray.Item.HitCounterYY
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.SellingStatusYY
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.Variations(Y)(Y)
ItemArray.Item.Variations.Variation(Y)(Y)
ItemArray.Item.Variations.Variation.Quantity(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.BidCount(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.CurrentPrice(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder-(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .Email		-(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .FeedbackScore		-(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .UserID		-(Y)
ItemArray.Item.Variations.Variation.SellingStatus.ListingStatus(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.QuantitySold(Y)(Y)
ItemArray.Item.Variations.Variation.SKU(Y)(Y)
ItemArray.Item.Variations.Variation.StartPrice(Y)(Y)
ItemArray.Item.Variations.Variation.VariationSpecifics(Y)(Y)
ItemArray.Item.Variations.Variation.VariationSpecifics
  .NameValueList		(Y)(Y)
ItemArray.Item.Variations.Variation.VariationSpecifics
  .NameValueList.Name		(Y)(Y)
ItemArray.Item.Variations.Variation.VariationSpecifics
  .NameValueList.Value		(Y)(Y)
ItemArray.Item.WatchCount-(Y)
TimeToYY



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetSellerEvents User Notes

GetSellerEvents Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

The following sample returns items that incurred a seller event within the time period specified. Because no end time is specified, the time period begins with the time specified with StartTimeFrom and ends with the time the call was issued. The response includes only items listed by the authorized user of the call. With DetailLevel set to ReturnAll, all applicable fields are included in the response.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<GetSellerEventsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <StartTimeFrom>2009-10-01T00:00:01.000Z</StartTimeFrom>
  <DetailLevel>ReturnAll</DetailLevel>
 </GetSellerEventsRequest>

Output

XML format. Also available is the .txt version of this XML.

<GetSellerEventsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-10-28T23:11:47.103Z</Timestamp>
  <Ack>Success</Ack>
  <Version>637</Version>
  <Build>E637_CORE_BUNDLED_10202911_R1</Build>
  <TimeTo>2009-10-28T23:11:45.666Z</TimeTo>
  <ItemArray>
    <Item>
      <ItemID>230389864438</ItemID>
      <ListingDetails>
        <StartTime>2009-10-18T20:41:50.000Z</StartTime>
        <EndTime>2009-10-25T20:41:50.000Z</EndTime>
      </ListingDetails>
      <SellingStatus>
        <BidCount>1</BidCount>
        <CurrentPrice currencyID="USD">60.0</CurrentPrice>
        <QuantitySold>1</QuantitySold>
        <HighBidder>
          <UserID>bigbuyer</UserID>
          <UserAnonymized>false</UserAnonymized>
          <Email>bigbuyer@aol.com</Email>
          <FeedbackScore>6</FeedbackScore>
        </HighBidder>
        <ListingStatus>Completed</ListingStatus>
      </SellingStatus>
      <Site>US</Site>
      <Title>TaylorMade Rossa Monza Itsy Bitsy Spider Putter 34"</Title>
      <Currency>USD</Currency>
      <ListingType>Chinese</ListingType>
      <BestOfferDetails>
        <BestOfferEnabled>false</BestOfferEnabled>
      </BestOfferDetails>
      <HitCounter>BasicStyle</HitCounter>
      <HitCount>90</HitCount>
    </Item>
    <Item>
      <ItemID>230389869149</ItemID>
      <ListingDetails>
        <StartTime>2009-10-18T20:50:00.000Z</StartTime>
        <EndTime>2009-10-25T20:50:00.000Z</EndTime>
      </ListingDetails>
      <SellingStatus>
        <BidCount>0</BidCount>
        <CurrentPrice currencyID="USD">22.5</CurrentPrice>
        <QuantitySold>0</QuantitySold>
        <ListingStatus>Completed</ListingStatus>
      </SellingStatus>
      <Site>US</Site>
      <Title>Callaway Steelhead X-16 Pro Series 4 Iron</Title>
      <Currency>USD</Currency>
      <ListingType>Chinese</ListingType>
      <BestOfferDetails>
        <BestOfferEnabled>false</BestOfferEnabled>
      </BestOfferDetails>
      <HitCounter>BasicStyle</HitCounter>
      <HitCount>19</HitCount>
    </Item>
    <Item>
      <ItemID>230389873309</ItemID>
      <ListingDetails>
        <StartTime>2009-10-18T20:57:08.000Z</StartTime>
        <EndTime>2009-10-25T20:57:08.000Z</EndTime>
      </ListingDetails>
      <SellingStatus>
        <BidCount>1</BidCount>
        <CurrentPrice currencyID="USD">80.0</CurrentPrice>
        <QuantitySold>1</QuantitySold>
        <HighBidder>
          <UserID>bensonbuyer</UserID>
          <UserAnonymized>false</UserAnonymized>
          <Email>bensonbuyer@aol.com</Email>
          <FeedbackScore>6</FeedbackScore>
        </HighBidder>
        <ListingStatus>Completed</ListingStatus>
      </SellingStatus>
      <Site>US</Site>
      <Title>Acopa JB (John Bachar) climbing shoes Size 9 1/2  NIB</Title>
      <Currency>USD</Currency>
      <ListingType>Chinese</ListingType>
      <BestOfferDetails>
        <BestOfferEnabled>false</BestOfferEnabled>
      </BestOfferDetails>
      <HitCounter>BasicStyle</HitCounter>
      <HitCount>35</HitCount>
    </Item>
    <Item>
      <ItemID>230392367173</ItemID>
      <ListingDetails>
        <StartTime>2009-10-26T03:48:12.000Z</StartTime>
        <EndTime>2009-11-02T03:48:12.000Z</EndTime>
      </ListingDetails>
      <SellingStatus>
        <BidCount>0</BidCount>
        <CurrentPrice currencyID="USD">22.5</CurrentPrice>
        <QuantitySold>0</QuantitySold>
        <ListingStatus>Active</ListingStatus>
      </SellingStatus>
      <Site>US</Site>
      <Title>Callaway Steelhead X-16 Pro Series 4 Iron</Title>
      <Currency>USD</Currency>
      <ListingType>Chinese</ListingType>
      <BestOfferDetails>
        <BestOfferEnabled>false</BestOfferEnabled>
      </BestOfferDetails>
      <HitCounter>BasicStyle</HitCounter>
      <HitCount>6</HitCount>
    </Item>
  </ItemArray>
</GetSellerEventsResponse>



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetSellerEvents User Notes

GetSellerEvents Change History

Version Description
763
2012-02-29
  • Item.SellerProfiles.SellerPaymentProfile (added): This container is returned if a Business Policies payment profile was applied to the listing. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
  • Item.SellerProfiles.SellerReturnProfile (added): This container is returned if a Business Policies return policy profile was applied to the listing. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
  • Item.SellerProfiles.SellerShippingProfile (added): This container is returned if a Business Policies shipping profile was applied to the listing. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
  • Item.ShippingPackageDetails (added): If the seller is using calculated shipping, this container is used to specify the weight and dimensions of an item's shipping package. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
675
2010-06-23
  • Item (modified): Limit increased to 3000. If 3000 or more items are returned, it means items may be missing and you should use a shorter time range filter.
669
2010-05-12
  • HideVariations (added): Boolean input field that, when set to true, suppresses variation details in the response. Use HideVariations to reduce the response size if you use other calls, alerts, notifications, or reports to track changes to variation details.
629
2009-08-05
  • Item.Variations, IncludeVariationSpecifics (added): Variation details are now returned, including StartPrice, Quantity, QuantitySold, plus SKU and/or VariationSpecifics. Use IncludeVariationSpecifics to control the size of the variations response.
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.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetSellerEvents User Notes

User-Contributed Notes

   
 
 
 

Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.