GetMyeBayBuying

Use this call to return information from the All Buying section of the authenticated user's My eBay account. You can review items that the user is watching, bidding on, has won, has not won, and those items on which they have made best offers or second chance offers. You can return a user's saved searches, their favorite sellers, and items that they have deleted from their lost and won lists. You can also return the lists that were created by the user (known as user defined lists).

GetMyeBayBuying returns information for only the user authenticated with the call. Responses are based on the information in their My eBay account.

Request Details

Depending on the buying information you want to inspect, GetMyeBayBuying can return any combination of buying information contained in the user's My eBay account. For each response container you want returned, specify a value of true in the respective container's Include field in your request. For example, the following code returns the list of items that the user is currently watching:

  <WatchList>
    <Include>true</Include>
  </WatchList>

Each response container returns with a default set of fields. If you need, use the controls provided in each container to filter or alter the presentation of the default response set. For example, some containers can be sorted and some support pagination.

To return all the buying containers, set DetailLevel to ReturnAll. In this case, you only have to specify a container if you want to override the default return set with a custom setting. If you want to exclude a specific container from the response, set Include to false in the appropriate container.

Note, however, that BuyingSummary is not automatically returned when DetailLevel is set to ReturnAll; if you want a buying summary returned, you must specify the container in the request.

GetMyeBayBuying does not provide a way to specify maximum number of records returned that applies to all containers. However, you can specify the maximum number of records returned per container, provided that the container supports the MaxResults element.

In the UserDefinedLists container, you can specify whether all user defined lists are returned, or only the one specified. You can also specify whether list contents are returned, or only the names of the user defined lists.

Working with the Response

The BestOfferList, BidList, DeleteFromLostList, DeleteFromWonList, LostList, WatchList, and WonList containers all support pagination. It is recommended that you use pagination because results can be quite long.

The UserDefinedList container can return lists of sellers, searches, and/or items, depending on what the user has added.

Testing GetMyeBayBuying

You can test GetMyeBayBuying in the Sandbox. Because the call returns information for only the user making the call, you will need to use several test users to fully test the call. Create tokens for the different users and use the appropriate tokens when making calls for the different users. If needed, you can use automated test users in the Sandbox; see Using the Sandbox for more information.

Create several sample listings with one registered Sandbox user. Use different (buying) Sandbox users to place bids and watches on the listings. With the buying test users, create and save searches and favorite seller lists.

When testing this call, make sure that the items returned in WatchList or BidList are active listings. Also, make sure that items returned in WonList or LostList are for listings that have ended. Check the user's My eBay accounts in the Sandbox user interface and make sure the lists returned by the call match those in the UI.

Request a WatchList, BidList, WonList, or LostList and specify a DurationInDays (valid values are 0-60). Check the user's My eBay account in the user interface and make sure the correct items are returned for the duration you specify.

Related Information

See My eBay.

See also the reference documentation for these calls:



Back to top

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

GetMyeBayBuying 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"?>
<GetMyeBayBuyingRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <BestOfferList> ItemListCustomizationType
    <DurationInDays> int </DurationInDays>
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <ListingType> ListingTypeCodeType </ListingType>
    <Pagination> PaginationType
      <EntriesPerPage> int </EntriesPerPage>
      <PageNumber> int </PageNumber>
    </Pagination>
    <Sort> ItemSortTypeCodeType </Sort>
  </BestOfferList>
  <BidList> ItemListCustomizationType
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <Pagination> PaginationType
      <EntriesPerPage> int </EntriesPerPage>
      <PageNumber> int </PageNumber>
    </Pagination>
    <Sort> ItemSortTypeCodeType </Sort>
  </BidList>
  <BuyingSummary> ItemListCustomizationType
    <Include> boolean </Include>
  </BuyingSummary>
  <DeletedFromLostList> ItemListCustomizationType
    <DurationInDays> int </DurationInDays>
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <Pagination> PaginationType
      <EntriesPerPage> int </EntriesPerPage>
      <PageNumber> int </PageNumber>
    </Pagination>
    <Sort> ItemSortTypeCodeType </Sort>
  </DeletedFromLostList>
  <DeletedFromWonList> ItemListCustomizationType
    <DurationInDays> int </DurationInDays>
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <Pagination> PaginationType
      <EntriesPerPage> int </EntriesPerPage>
      <PageNumber> int </PageNumber>
    </Pagination>
    <Sort> ItemSortTypeCodeType </Sort>
  </DeletedFromWonList>
  <FavoriteSearches> MyeBaySelectionType
    <Include> boolean </Include>
    <IncludeFavoriteSellerCount> boolean </IncludeFavoriteSellerCount>
    <IncludeItemCount> boolean </IncludeItemCount>
    <MaxResults> int </MaxResults>
    <Sort> SortOrderCodeType </Sort>
  </FavoriteSearches>
  <FavoriteSellers> MyeBaySelectionType
    <Include> boolean </Include>
    <IncludeFavoriteSellerCount> boolean </IncludeFavoriteSellerCount>
    <IncludeItemCount> boolean </IncludeItemCount>
    <MaxResults> int </MaxResults>
    <Sort> SortOrderCodeType </Sort>
  </FavoriteSellers>
  <HideVariations> boolean </HideVariations>
  <LostList> ItemListCustomizationType
    <DurationInDays> int </DurationInDays>
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <Pagination> PaginationType
      <EntriesPerPage> int </EntriesPerPage>
      <PageNumber> int </PageNumber>
    </Pagination>
    <Sort> ItemSortTypeCodeType </Sort>
  </LostList>
  <SecondChanceOffer> MyeBaySelectionType
    <Include> boolean </Include>
    <IncludeFavoriteSellerCount> boolean </IncludeFavoriteSellerCount>
    <IncludeItemCount> boolean </IncludeItemCount>
    <MaxResults> int </MaxResults>
    <Sort> SortOrderCodeType </Sort>
  </SecondChanceOffer>
  <UserDefinedLists> MyeBaySelectionType
    <Include> boolean </Include>
    <IncludeFavoriteSellerCount> boolean </IncludeFavoriteSellerCount>
    <IncludeItemCount> boolean </IncludeItemCount>
    <IncludeListContents> boolean </IncludeListContents>
    <MaxResults> int </MaxResults>
    <Sort> SortOrderCodeType </Sort>
    <UserDefinedListName> string </UserDefinedListName>
  </UserDefinedLists>
  <WatchList> ItemListCustomizationType
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <Pagination> PaginationType
      <EntriesPerPage> int </EntriesPerPage>
      <PageNumber> int </PageNumber>
    </Pagination>
    <Sort> ItemSortTypeCodeType </Sort>
  </WatchList>
  <WonList> ItemListCustomizationType
    <DurationInDays> int </DurationInDays>
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <Pagination> PaginationType
      <EntriesPerPage> int </EntriesPerPage>
      <PageNumber> int </PageNumber>
    </Pagination>
    <Sort> ItemSortTypeCodeType </Sort>
  </WonList>
  <!-- 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>
</GetMyeBayBuyingRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
BestOfferList ItemListCustomizationType Optional Returns the list of items on which the user has placed Best Offers.

Set Include to true to return the default response set.
BestOfferList.DurationInDays int Optional Specifies the time period during which an item was won or lost. Similar to the period drop-down menu in the My eBay user interface. For example, to return the items won or lost in the last week, specify a DurationInDays of 7.
Min: 0. Max: 60.
BestOfferList.Include boolean Optional Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
BestOfferList.IncludeNotes boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
BestOfferList.ListingType ListingTypeCodeType Optional Specifies the listing type of items in the returned list.

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.

•   Auction

(in/out) An optional input parameter used with GetMyeBaySelling. When used in the request, returns items of competitive-bid auctions.

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


(Not all values in ListingTypeCodeType apply to this field.)
BestOfferList.Pagination PaginationType Optional Specifies how to create virtual pages in the returned list.
Default for EntriesPerPage with GetMyeBayBuying is 200.
BestOfferList.Pagination
  .EntriesPerPage 		int Optional This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.

For GetOrders, the maximum value is 100 and the default value is 25 orders per page.

For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored.

For GetProducts, the maximum value is 20, and any higher values are ignored.
BestOfferList.Pagination
  .PageNumber 		int Optional Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value.
Min: 1. Default: 1.
BestOfferList.Sort ItemSortTypeCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values: See Sort.
BidList ItemListCustomizationType Optional Returns the list of items on which the user has bid.

Set Include to true to return the default response set.
BidList.Include boolean Optional Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
BidList.IncludeNotes boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
BidList.Pagination PaginationType Optional Specifies how to create virtual pages in the returned list.
Default for EntriesPerPage with GetMyeBayBuying is 200.
BidList.Pagination
  .EntriesPerPage 		int Optional This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.

For GetOrders, the maximum value is 100 and the default value is 25 orders per page.

For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored.

For GetProducts, the maximum value is 20, and any higher values are ignored.
BidList.Pagination.PageNumber int Optional Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value.
Min: 1. Default: 1.
BidList.Sort ItemSortTypeCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values: See Sort.
BuyingSummary ItemListCustomizationType Optional Returns a summary of the user's buying activity.

Add a BuyingSummary element in the request with an Include field set to true to receive a BuyingSummary container in your response. Add a BuyingSummary element with an Include field set to false to exclude the BuyingSummary from your response.
BuyingSummary.Include boolean Optional Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
DeletedFromLostList ItemListCustomizationType Optional Returns the list of items (auctions) the user did not win and were subsequently deleted from their My eBay page.

Set Include to true to return the default response set.
DeletedFromLostList
  .DurationInDays 		int Optional Specifies the time period during which an item was won or lost. Similar to the period drop-down menu in the My eBay user interface. For example, to return the items won or lost in the last week, specify a DurationInDays of 7.
Min: 0. Max: 60.
DeletedFromLostList.Include boolean Optional Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
DeletedFromLostList
  .IncludeNotes 		boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
DeletedFromLostList.Pagination PaginationType Optional Specifies how to create virtual pages in the returned list.
Default for EntriesPerPage with GetMyeBayBuying is 200.
DeletedFromLostList.Pagination
  .EntriesPerPage 		int Optional This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.

For GetOrders, the maximum value is 100 and the default value is 25 orders per page.

For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored.

For GetProducts, the maximum value is 20, and any higher values are ignored.
DeletedFromLostList.Pagination
  .PageNumber 		int Optional Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value.
Min: 1. Default: 1.
DeletedFromLostList.Sort ItemSortTypeCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values: See Sort.
DeletedFromWonList ItemListCustomizationType Optional Returns the list of items the user has won, and subsequently deleted from their My eBay page.

Set Include to true to return the default response set.
DeletedFromWonList
  .DurationInDays 		int Optional Specifies the time period during which an item was won or lost. Similar to the period drop-down menu in the My eBay user interface. For example, to return the items won or lost in the last week, specify a DurationInDays of 7.
Min: 0. Max: 60.
DeletedFromWonList.Include boolean Optional Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
DeletedFromWonList
  .IncludeNotes 		boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
DeletedFromWonList.Pagination PaginationType Optional Specifies how to create virtual pages in the returned list.
Default for EntriesPerPage with GetMyeBayBuying is 200.
DeletedFromWonList.Pagination
  .EntriesPerPage 		int Optional This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.

For GetOrders, the maximum value is 100 and the default value is 25 orders per page.

For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored.

For GetProducts, the maximum value is 20, and any higher values are ignored.
DeletedFromWonList.Pagination
  .PageNumber 		int Optional Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value.
Min: 1. Default: 1.
DeletedFromWonList.Sort ItemSortTypeCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values: See Sort.
FavoriteSearches MyeBaySelectionType Optional Returns the list of searches that the user has saved in My eBay. Returned only if the user has saved searches.

Set Include to true to return the default response set.
FavoriteSearches.Include boolean Optional Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
FavoriteSearches
  .IncludeFavoriteSellerCount 		boolean Optional Specifies whether or not to include FavoriteSellerCount in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
FavoriteSearches
  .IncludeItemCount 		boolean Optional Specifies whether or not to include the item count in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
FavoriteSearches.MaxResults int Optional Specifies the maximum number of items in the returned list. If not specified, returns all items in the list.
FavoriteSearches.Sort SortOrderCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values:

•   Ascending

(in/out) The results will be sorted by the specified attribute in ascending (low to high) order.

•   CustomCode

(in/out) Reserved for internal or future use.

•   Descending

(in/out) The results will be sorted by the specified attribute in descending (high to low) order.
FavoriteSellers MyeBaySelectionType Optional Returns the list of favorite sellers that the user has saved in My eBay. Returned only if the user has saved a list of favorite sellers.

Set Include to true to return the default response set.
FavoriteSellers.Include boolean Optional Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
FavoriteSellers
  .IncludeFavoriteSellerCount 		boolean Optional Specifies whether or not to include FavoriteSellerCount in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
FavoriteSellers
  .IncludeItemCount 		boolean Optional Specifies whether or not to include the item count in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
FavoriteSellers.MaxResults int Optional Specifies the maximum number of items in the returned list. If not specified, returns all items in the list.
FavoriteSellers.Sort SortOrderCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values:

•   Ascending

(in/out) The results will be sorted by the specified attribute in ascending (low to high) order.

•   CustomCode

(in/out) Reserved for internal or future use.

•   Descending

(in/out) The results will be sorted by the specified attribute in descending (high to low) order.
HideVariations boolean Optional If true, the Variations node is omitted for all multi-variation listings in the response. If false, the Variations node is returned for all multi-variation listings in the response.

Please note that if the seller includes a large number of variations in many listings, retrieving variations (setting this flag to false) may degrade the call's performance. Therefore, when this is false, you may need to reduce the total number of items you're requesting at once (by using other input fields, such as Pagination).
Default: false.
LostList ItemListCustomizationType Optional Returns the list of items on which the user has bid on and lost.

Set Include to true to return the default response set.
LostList.DurationInDays int Optional Specifies the time period during which an item was won or lost. Similar to the period drop-down menu in the My eBay user interface. For example, to return the items won or lost in the last week, specify a DurationInDays of 7.
Min: 0. Max: 60.
LostList.Include boolean Optional Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
LostList.IncludeNotes boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
LostList.Pagination PaginationType Optional Specifies how to create virtual pages in the returned list.
Default for EntriesPerPage with GetMyeBayBuying is 200.
LostList.Pagination
  .EntriesPerPage 		int Optional This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.

For GetOrders, the maximum value is 100 and the default value is 25 orders per page.

For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored.

For GetProducts, the maximum value is 20, and any higher values are ignored.
LostList.Pagination.PageNumber int Optional Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value.
Min: 1. Default: 1.
LostList.Sort ItemSortTypeCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values: See Sort.
SecondChanceOffer MyeBaySelectionType Optional Returns the list of second chance offers made by the user. Returned only if the user has made second chance offers.

Set Include to true to return the default response set.
SecondChanceOffer.Include boolean Optional Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
SecondChanceOffer
  .IncludeFavoriteSellerCount 		boolean Optional Specifies whether or not to include FavoriteSellerCount in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
SecondChanceOffer
  .IncludeItemCount 		boolean Optional Specifies whether or not to include the item count in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
SecondChanceOffer.MaxResults int Optional Specifies the maximum number of items in the returned list. If not specified, returns all items in the list.
SecondChanceOffer.Sort SortOrderCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values:

•   Ascending

(in/out) The results will be sorted by the specified attribute in ascending (low to high) order.

•   CustomCode

(in/out) Reserved for internal or future use.

•   Descending

(in/out) The results will be sorted by the specified attribute in descending (high to low) order.
UserDefinedLists MyeBaySelectionType Optional Returns the user defined lists, which are lists created by the user in the eBay UI and filled with items, or sellers, or searches using the "Add to List" feature.

Set Include to true to return the default response set.
UserDefinedLists.Include boolean Optional Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
UserDefinedLists
  .IncludeFavoriteSellerCount 		boolean Optional Specifies whether or not to include FavoriteSellerCount in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
UserDefinedLists
  .IncludeItemCount 		boolean Optional Specifies whether or not to include the item count in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
UserDefinedLists
  .IncludeListContents 		boolean Optional Specify true to return the full user defined list contents in the response's UserDefinedList containers. A value of false means only a summary of the user defined list will be returned. The default value is false.
UserDefinedLists.MaxResults int Optional Specifies the maximum number of items in the returned list. If not specified, returns all items in the list.
UserDefinedLists.Sort SortOrderCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values:

•   Ascending

(in/out) The results will be sorted by the specified attribute in ascending (low to high) order.

•   CustomCode

(in/out) Reserved for internal or future use.

•   Descending

(in/out) The results will be sorted by the specified attribute in descending (high to low) order.
UserDefinedLists
  .UserDefinedListName 		string Optional Specifies that only the user defined list whose name matches the given name should be in the returned list. If the user does not have a matching record, no data is returned. If this element is omitted, the information for all records is returned. For use only within the UserDefinedLists element.
WatchList ItemListCustomizationType Optional Returns the list of items being watched by the user.

Set Include to true to return the default response set.
WatchList.Include boolean Optional Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
WatchList.IncludeNotes boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
WatchList.Pagination PaginationType Optional Specifies how to create virtual pages in the returned list.
Default for EntriesPerPage with GetMyeBayBuying is 200.
WatchList.Pagination
  .EntriesPerPage 		int Optional This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.

For GetOrders, the maximum value is 100 and the default value is 25 orders per page.

For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored.

For GetProducts, the maximum value is 20, and any higher values are ignored.
WatchList.Pagination
  .PageNumber 		int Optional Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value.
Min: 1. Default: 1.
WatchList.Sort ItemSortTypeCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values: See Sort.
WonList ItemListCustomizationType Optional Returns the list of items on which the use has bid.

Set Include to true to return the default response set.
WonList.DurationInDays int Optional Specifies the time period during which an item was won or lost. Similar to the period drop-down menu in the My eBay user interface. For example, to return the items won or lost in the last week, specify a DurationInDays of 7.
Min: 0. Max: 60.
WonList.Include boolean Optional Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container.

If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response.
WonList.IncludeNotes boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
WonList.Pagination PaginationType Optional Specifies how to create virtual pages in the returned list.
Default for EntriesPerPage with GetMyeBayBuying is 200.
WonList.Pagination
  .EntriesPerPage 		int Optional This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.

For GetOrders, the maximum value is 100 and the default value is 25 orders per page.

For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored.

For GetProducts, the maximum value is 20, and any higher values are ignored.
WonList.Pagination.PageNumber int Optional Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value.
Min: 1. Default: 1.
WonList.Sort ItemSortTypeCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values: See Sort.
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.

•   ReturnSummary

(in) Returns the summary data. For GetMyMessages, this detail level returns the same data whether or not you include MessageIDs or AlertIDs in the request. Returns up to 10 FolderID and FolderName values. Currently, this detail level is the only way to retrieve FolderID and FolderName values. See "GetMyMessages" in the eBay Web Services Guide for a code sample that demonstrates this.


(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 GetMyeBayBuying User Notes

GetMyeBayBuying 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"?>
<GetMyeBayBuyingResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <BestOfferList> PaginatedItemArrayType
    <ItemArray> ItemArrayType
      <Item> ItemType
        <BestOfferDetails> BestOfferDetailsType
          <BestOffer currencyID="CurrencyCodeType"> AmountType (double) </BestOffer>
          <BestOfferStatus> BestOfferStatusCodeType </BestOfferStatus>
        </BestOfferDetails>
        <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
        <eBayNotes> string </eBayNotes>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType
          <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
          <StartTime> dateTime </StartTime>
        </ListingDetails>
        <PictureDetails> PictureDetailsType
          <GalleryURL> anyURI </GalleryURL>
        </PictureDetails>
        <PrivateNotes> string </PrivateNotes>
        <Seller> UserType
          <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
          <FeedbackScore> int </FeedbackScore>
          <UserID> UserIDType (string) </UserID>
        </Seller>
        <SellingStatus> SellingStatusType
          <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType
          <ShippingServiceOptions> ShippingServiceOptionsType
            <LocalPickup> boolean </LocalPickup>
            <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          </ShippingServiceOptions>
          <!-- ... more ShippingServiceOptions nodes allowed here ... -->
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <Site> SiteCodeType </Site>
        <SubTitle> string </SubTitle>
        <TimeLeft> duration </TimeLeft>
        <Title> string </Title>
      </Item>
      <!-- ... more Item nodes allowed here ... -->
    </ItemArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </BestOfferList>
  <BidList> PaginatedItemArrayType
    <ItemArray> ItemArrayType
      <Item> ItemType
        <BiddingDetails> BiddingDetailsType
          <ConvertedMaxBid currencyID="CurrencyCodeType"> AmountType (double) </ConvertedMaxBid>
          <MaxBid currencyID="CurrencyCodeType"> AmountType (double) </MaxBid>
          <QuantityBid> int </QuantityBid>
          <QuantityWon> int </QuantityWon>
        </BiddingDetails>
        <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
        <eBayNotes> string </eBayNotes>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType
          <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
          <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
          <EndTime> dateTime </EndTime>
          <StartTime> dateTime </StartTime>
        </ListingDetails>
        <ListingType> ListingTypeCodeType </ListingType>
        <PictureDetails> PictureDetailsType
          <GalleryURL> anyURI </GalleryURL>
        </PictureDetails>
        <PrivateNotes> string </PrivateNotes>
        <Seller> UserType
          <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
          <FeedbackScore> int </FeedbackScore>
          <UserID> UserIDType (string) </UserID>
        </Seller>
        <SellingStatus> SellingStatusType
          <BidCount> int </BidCount>
          <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
          <HighBidder> UserType
            <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
            <FeedbackScore> int </FeedbackScore>
            <UserID> UserIDType (string) </UserID>
          </HighBidder>
          <ReserveMet> boolean </ReserveMet>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType
          <ShippingServiceOptions> ShippingServiceOptionsType
            <LocalPickup> boolean </LocalPickup>
            <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
            <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
          </ShippingServiceOptions>
          <!-- ... more ShippingServiceOptions nodes allowed here ... -->
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <Site> SiteCodeType </Site>
        <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
        <SubTitle> string </SubTitle>
        <TimeLeft> duration </TimeLeft>
        <Title> string </Title>
      </Item>
      <!-- ... more Item nodes allowed here ... -->
    </ItemArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </BidList>
  <BuyingSummary> BuyingSummaryType
    <BestOfferCount> int </BestOfferCount>
    <BiddingCount> int </BiddingCount>
    <TotalWinningCost currencyID="CurrencyCodeType"> AmountType (double) </TotalWinningCost>
    <TotalWonCost currencyID="CurrencyCodeType"> AmountType (double) </TotalWonCost>
    <WinningCount> int </WinningCount>
    <WonCount> int </WonCount>
    <WonDurationInDays> int </WonDurationInDays>
  </BuyingSummary>
  <DeletedFromLostList> PaginatedItemArrayType
    <ItemArray> ItemArrayType
      <Item> ItemType
        <BiddingDetails> BiddingDetailsType
          <ConvertedMaxBid currencyID="CurrencyCodeType"> AmountType (double) </ConvertedMaxBid>
          <MaxBid currencyID="CurrencyCodeType"> AmountType (double) </MaxBid>
          <QuantityBid> int </QuantityBid>
          <QuantityWon> int </QuantityWon>
        </BiddingDetails>
        <eBayNotes> string </eBayNotes>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType
          <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
          <EndTime> dateTime </EndTime>
          <StartTime> dateTime </StartTime>
        </ListingDetails>
        <ListingType> ListingTypeCodeType </ListingType>
        <PictureDetails> PictureDetailsType
          <GalleryURL> anyURI </GalleryURL>
        </PictureDetails>
        <PrivateNotes> string </PrivateNotes>
        <Seller> UserType
          <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
          <FeedbackScore> int </FeedbackScore>
          <UserID> UserIDType (string) </UserID>
        </Seller>
        <SellingStatus> SellingStatusType
          <BidCount> int </BidCount>
          <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
          <HighBidder> UserType
            <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
            <FeedbackScore> int </FeedbackScore>
            <UserID> UserIDType (string) </UserID>
          </HighBidder>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <Site> SiteCodeType </Site>
        <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
        <SubTitle> string </SubTitle>
        <Title> string </Title>
        <Variations> VariationsType
          <Variation> VariationType
            <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>
      </Item>
      <!-- ... more Item nodes allowed here ... -->
    </ItemArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </DeletedFromLostList>
  <DeletedFromWonList> PaginatedOrderTransactionArrayType
    <OrderTransactionArray> OrderTransactionArrayType
      <OrderTransaction> OrderTransactionType
        <Order> OrderType
          <OrderID> OrderIDType (string) </OrderID>
          <Subtotal currencyID="CurrencyCodeType"> AmountType (double) </Subtotal>
          <TransactionArray> TransactionArrayType
            <Transaction> TransactionType
              <BuyerPaidStatus> PaidStatusCodeType </BuyerPaidStatus>
              <CreatedDate> dateTime </CreatedDate>
              <FeedbackLeft> FeedbackInfoType
                <CommentType> CommentTypeCodeType </CommentType>
              </FeedbackLeft>
              <FeedbackReceived> FeedbackInfoType
                <CommentType> CommentTypeCodeType </CommentType>
              </FeedbackReceived>
              <Item> ItemType
                <BiddingDetails> BiddingDetailsType
                  <ConvertedMaxBid currencyID="CurrencyCodeType"> AmountType (double) </ConvertedMaxBid>
                  <MaxBid currencyID="CurrencyCodeType"> AmountType (double) </MaxBid>
                  <QuantityBid> int </QuantityBid>
                  <QuantityWon> int </QuantityWon>
                </BiddingDetails>
                <eBayNotes> string </eBayNotes>
                <ItemID> ItemIDType (string) </ItemID>
                <ListingDetails> ListingDetailsType
                  <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
                  <EndTime> dateTime </EndTime>
                  <StartTime> dateTime </StartTime>
                </ListingDetails>
                <ListingType> ListingTypeCodeType </ListingType>
                <PictureDetails> PictureDetailsType
                  <GalleryURL> anyURI </GalleryURL>
                </PictureDetails>
                <PrivateNotes> string </PrivateNotes>
                <Seller> UserType
                  <Email> string </Email>
                  <UserID> UserIDType (string) </UserID>
                </Seller>
                <SellingStatus> SellingStatusType
                  <BidCount> int </BidCount>
                  <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
                  <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
                </SellingStatus>
                <ShippingDetails> ShippingDetailsType
                  <ShippingServiceOptions> ShippingServiceOptionsType
                    <LocalPickup> boolean </LocalPickup>
                    <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
                  </ShippingServiceOptions>
                  <!-- ... more ShippingServiceOptions nodes allowed here ... -->
                  <ShippingType> ShippingTypeCodeType </ShippingType>
                </ShippingDetails>
                <Site> SiteCodeType </Site>
                <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
                <SubTitle> string </SubTitle>
                <Title> string </Title>
                <Variations> VariationsType
                  <Variation> VariationType
                    <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>
              </Item>
              <OrderLineItemID> string </OrderLineItemID>
              <PaidTime> dateTime </PaidTime>
              <PaisaPayID> string </PaisaPayID>
              <Platform> TransactionPlatformCodeType </Platform>
              <QuantityPurchased> int </QuantityPurchased>
              <ShippedTime> dateTime </ShippedTime>
              <Status> TransactionStatusType
                <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
              </Status>
              <TotalPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalPrice>
              <TotalTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalTransactionPrice>
              <TransactionID> string </TransactionID>
            </Transaction>
            <!-- ... more Transaction nodes allowed here ... -->
          </TransactionArray>
        </Order>
        <Transaction> TransactionType
          <BuyerPaidStatus> PaidStatusCodeType </BuyerPaidStatus>
          <CreatedDate> dateTime </CreatedDate>
          <FeedbackLeft> FeedbackInfoType
            <CommentType> CommentTypeCodeType </CommentType>
          </FeedbackLeft>
          <FeedbackReceived> FeedbackInfoType
            <CommentType> CommentTypeCodeType </CommentType>
          </FeedbackReceived>
          <Item> ItemType
            <BiddingDetails> BiddingDetailsType
              <ConvertedMaxBid currencyID="CurrencyCodeType"> AmountType (double) </ConvertedMaxBid>
              <MaxBid currencyID="CurrencyCodeType"> AmountType (double) </MaxBid>
              <QuantityBid> int </QuantityBid>
              <QuantityWon> int </QuantityWon>
            </BiddingDetails>
            <eBayNotes> string </eBayNotes>
            <ItemID> ItemIDType (string) </ItemID>
            <ListingDetails> ListingDetailsType
              <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
              <EndTime> dateTime </EndTime>
              <StartTime> dateTime </StartTime>
            </ListingDetails>
            <ListingType> ListingTypeCodeType </ListingType>
            <PictureDetails> PictureDetailsType
              <GalleryURL> anyURI </GalleryURL>
            </PictureDetails>
            <PrivateNotes> string </PrivateNotes>
            <Seller> UserType
              <Email> string </Email>
              <UserID> UserIDType (string) </UserID>
            </Seller>
            <SellingStatus> SellingStatusType
              <BidCount> int </BidCount>
              <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
              <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
            </SellingStatus>
            <ShippingDetails> ShippingDetailsType
              <ShippingServiceOptions> ShippingServiceOptionsType
                <LocalPickup> boolean </LocalPickup>
                <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
              </ShippingServiceOptions>
              <!-- ... more ShippingServiceOptions nodes allowed here ... -->
              <ShippingType> ShippingTypeCodeType </ShippingType>
            </ShippingDetails>
            <Site> SiteCodeType </Site>
            <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
            <SubTitle> string </SubTitle>
            <Title> string </Title>
            <Variations> VariationsType
              <Variation> VariationType
                <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>
          </Item>
          <OrderLineItemID> string </OrderLineItemID>
          <PaidTime> dateTime </PaidTime>
          <PaisaPayID> string </PaisaPayID>
          <Platform> TransactionPlatformCodeType </Platform>
          <QuantityPurchased> int </QuantityPurchased>
          <ShippedTime> dateTime </ShippedTime>
          <Status> TransactionStatusType
            <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
          </Status>
          <TotalPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalPrice>
          <TotalTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalTransactionPrice>
          <TransactionID> string </TransactionID>
        </Transaction>
      </OrderTransaction>
      <!-- ... more OrderTransaction nodes allowed here ... -->
    </OrderTransactionArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </DeletedFromWonList>
  <FavoriteSearches> MyeBayFavoriteSearchListType
    <FavoriteSearch> MyeBayFavoriteSearchType
      <BidCountMax> int </BidCountMax>
      <BidCountMin> int </BidCountMin>
      <CategoryID> string </CategoryID>
      <Condition> ItemConditionCodeType </Condition>
      <Currency> CurrencyCodeType </Currency>
      <EndTimeFrom> dateTime </EndTimeFrom>
      <EndTimeTo> dateTime </EndTimeTo>
      <ItemsAvailableTo> CountryCodeType </ItemsAvailableTo>
      <ItemsLocatedIn> CountryCodeType </ItemsLocatedIn>
      <ItemSort> SimpleItemSortCodeType </ItemSort>
      <ItemType> ItemTypeCodeType </ItemType>
      <MaxDistance> int </MaxDistance>
      <PaymentMethod> PaymentMethodSearchCodeType </PaymentMethod>
      <PostalCode> string </PostalCode>
      <PreferredLocation> PreferredLocationCodeType </PreferredLocation>
      <PriceMax currencyID="CurrencyCodeType"> AmountType (double) </PriceMax>
      <PriceMin currencyID="CurrencyCodeType"> AmountType (double) </PriceMin>
      <Quantity> int </Quantity>
      <QuantityOperator> QuantityOperatorCodeType </QuantityOperator>
      <QueryKeywords> string </QueryKeywords>
      <SearchFlag> SearchFlagCodeType </SearchFlag>
      <!-- ... more SearchFlag values allowed here ... -->
      <SearchName> string </SearchName>
      <SearchQuery> string </SearchQuery>
      <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
      <SellerID> string </SellerID>
      <!-- ... more SellerID values allowed here ... -->
      <SellerIDExclude> string </SellerIDExclude>
      <!-- ... more SellerIDExclude values allowed here ... -->
      <SortOrder> SortOrderCodeType </SortOrder>
    </FavoriteSearch>
    <!-- ... more FavoriteSearch nodes allowed here ... -->
    <TotalAvailable> int </TotalAvailable>
  </FavoriteSearches>
  <FavoriteSellers> MyeBayFavoriteSellerListType
    <FavoriteSeller> MyeBayFavoriteSellerType
      <StoreName> string </StoreName>
      <UserID> string </UserID>
    </FavoriteSeller>
    <!-- ... more FavoriteSeller nodes allowed here ... -->
    <TotalAvailable> int </TotalAvailable>
  </FavoriteSellers>
  <LostList> PaginatedItemArrayType
    <ItemArray> ItemArrayType
      <Item> ItemType
        <BiddingDetails> BiddingDetailsType
          <ConvertedMaxBid currencyID="CurrencyCodeType"> AmountType (double) </ConvertedMaxBid>
          <MaxBid currencyID="CurrencyCodeType"> AmountType (double) </MaxBid>
          <QuantityBid> int </QuantityBid>
          <QuantityWon> int </QuantityWon>
        </BiddingDetails>
        <eBayNotes> string </eBayNotes>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType
          <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
          <EndTime> dateTime </EndTime>
          <StartTime> dateTime </StartTime>
        </ListingDetails>
        <ListingType> ListingTypeCodeType </ListingType>
        <PictureDetails> PictureDetailsType
          <GalleryURL> anyURI </GalleryURL>
        </PictureDetails>
        <PrivateNotes> string </PrivateNotes>
        <Seller> UserType
          <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
          <FeedbackScore> int </FeedbackScore>
          <UserID> UserIDType (string) </UserID>
        </Seller>
        <SellingStatus> SellingStatusType
          <BidCount> int </BidCount>
          <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
          <HighBidder> UserType
            <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
            <FeedbackScore> int </FeedbackScore>
            <UserID> UserIDType (string) </UserID>
          </HighBidder>
        </SellingStatus>
        <Site> SiteCodeType </Site>
        <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
        <SubTitle> string </SubTitle>
        <Title> string </Title>
        <Variations> VariationsType
          <Variation> VariationType
            <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>
      </Item>
      <!-- ... more Item nodes allowed here ... -->
    </ItemArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </LostList>
  <SecondChanceOffer> ItemType
    <eBayNotes> string </eBayNotes>
    <ItemID> ItemIDType (string) </ItemID>
    <ListingDetails> ListingDetailsType
      <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
      <EndTime> dateTime </EndTime>
    </ListingDetails>
    <PictureDetails> PictureDetailsType
      <GalleryURL> anyURI </GalleryURL>
    </PictureDetails>
    <PrivateNotes> string </PrivateNotes>
    <Site> SiteCodeType </Site>
    <SubTitle> string </SubTitle>
    <TimeLeft> duration </TimeLeft>
    <Title> string </Title>
  </SecondChanceOffer>
  <!-- ... more SecondChanceOffer nodes allowed here ... -->
  <UserDefinedList> UserDefinedListType
    <FavoriteSearches> MyeBayFavoriteSearchListType
      <FavoriteSearch> MyeBayFavoriteSearchType
        <BidCountMax> int </BidCountMax>
        <BidCountMin> int </BidCountMin>
        <CategoryID> string </CategoryID>
        <Condition> ItemConditionCodeType </Condition>
        <Currency> CurrencyCodeType </Currency>
        <EndTimeFrom> dateTime </EndTimeFrom>
        <EndTimeTo> dateTime </EndTimeTo>
        <ItemsAvailableTo> CountryCodeType </ItemsAvailableTo>
        <ItemsLocatedIn> CountryCodeType </ItemsLocatedIn>
        <ItemSort> SimpleItemSortCodeType </ItemSort>
        <ItemType> ItemTypeCodeType </ItemType>
        <MaxDistance> int </MaxDistance>
        <PaymentMethod> PaymentMethodSearchCodeType </PaymentMethod>
        <PostalCode> string </PostalCode>
        <PreferredLocation> PreferredLocationCodeType </PreferredLocation>
        <PriceMax currencyID="CurrencyCodeType"> AmountType (double) </PriceMax>
        <PriceMin currencyID="CurrencyCodeType"> AmountType (double) </PriceMin>
        <Quantity> int </Quantity>
        <QuantityOperator> QuantityOperatorCodeType </QuantityOperator>
        <QueryKeywords> string </QueryKeywords>
        <SearchFlag> SearchFlagCodeType </SearchFlag>
        <!-- ... more SearchFlag values allowed here ... -->
        <SearchName> string </SearchName>
        <SearchQuery> string </SearchQuery>
        <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
        <SellerID> string </SellerID>
        <!-- ... more SellerID values allowed here ... -->
        <SellerIDExclude> string </SellerIDExclude>
        <!-- ... more SellerIDExclude values allowed here ... -->
        <SortOrder> SortOrderCodeType </SortOrder>
      </FavoriteSearch>
      <!-- ... more FavoriteSearch nodes allowed here ... -->
      <TotalAvailable> int </TotalAvailable>
    </FavoriteSearches>
    <FavoriteSellerCount> int </FavoriteSellerCount>
    <FavoriteSellers> MyeBayFavoriteSellerListType
      <FavoriteSeller> MyeBayFavoriteSellerType
        <StoreName> string </StoreName>
        <UserID> string </UserID>
      </FavoriteSeller>
      <!-- ... more FavoriteSeller nodes allowed here ... -->
      <TotalAvailable> int </TotalAvailable>
    </FavoriteSellers>
    <ItemArray> ItemArrayType
      <Item> ItemType
        <eBayNotes> string </eBayNotes>
        <PrivateNotes> string </PrivateNotes>
        <ProductListingDetails> ProductListingDetailsType
          <ProductDetailsURL> anyURI </ProductDetailsURL>
          <ProductID> string </ProductID>
          <StockPhotoURL> anyURI </StockPhotoURL>
        </ProductListingDetails>
      </Item>
      <!-- ... more Item nodes allowed here ... -->
    </ItemArray>
    <ItemCount> int </ItemCount>
    <Name> string </Name>
  </UserDefinedList>
  <!-- ... more UserDefinedList nodes allowed here ... -->
  <WatchList> PaginatedItemArrayType
    <ItemArray> ItemArrayType
      <Item> ItemType
        <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
        <eBayNotes> string </eBayNotes>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType
          <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
          <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
          <EndTime> dateTime </EndTime>
          <StartTime> dateTime </StartTime>
          <ViewItemURL> anyURI </ViewItemURL>
        </ListingDetails>
        <ListingType> ListingTypeCodeType </ListingType>
        <PictureDetails> PictureDetailsType
          <GalleryURL> anyURI </GalleryURL>
        </PictureDetails>
        <PrivateNotes> string </PrivateNotes>
        <QuantityAvailable> int </QuantityAvailable>
        <Seller> UserType
          <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
          <FeedbackScore> int </FeedbackScore>
          <UserID> UserIDType (string) </UserID>
        </Seller>
        <SellingStatus> SellingStatusType
          <BidCount> int </BidCount>
          <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
          <HighBidder> UserType
            <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
            <FeedbackScore> int </FeedbackScore>
            <UserID> UserIDType (string) </UserID>
          </HighBidder>
          <PromotionalSaleDetails> PromotionalSaleDetailsType
            <EndTime> dateTime </EndTime>
            <OriginalPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalPrice>
            <StartTime> dateTime </StartTime>
          </PromotionalSaleDetails>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType
          <ShippingServiceOptions> ShippingServiceOptionsType
            <LocalPickup> boolean </LocalPickup>
            <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          </ShippingServiceOptions>
          <!-- ... more ShippingServiceOptions nodes allowed here ... -->
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <Site> SiteCodeType </Site>
        <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
        <SubTitle> string </SubTitle>
        <TimeLeft> duration </TimeLeft>
        <Title> string </Title>
        <Variations> VariationsType
          <Variation> VariationType
            <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>
      </Item>
      <!-- ... more Item nodes allowed here ... -->
    </ItemArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </WatchList>
  <WonList> PaginatedOrderTransactionArrayType
    <OrderTransactionArray> OrderTransactionArrayType
      <OrderTransaction> OrderTransactionType
        <Order> OrderType
          <OrderID> OrderIDType (string) </OrderID>
          <Subtotal currencyID="CurrencyCodeType"> AmountType (double) </Subtotal>
          <TransactionArray> TransactionArrayType
            <Transaction> TransactionType
              <BuyerPaidStatus> PaidStatusCodeType </BuyerPaidStatus>
              <CreatedDate> dateTime </CreatedDate>
              <FeedbackLeft> FeedbackInfoType
                <CommentType> CommentTypeCodeType </CommentType>
              </FeedbackLeft>
              <FeedbackReceived> FeedbackInfoType
                <CommentType> CommentTypeCodeType </CommentType>
              </FeedbackReceived>
              <Item> ItemType
                <BiddingDetails> BiddingDetailsType
                  <ConvertedMaxBid currencyID="CurrencyCodeType"> AmountType (double) </ConvertedMaxBid>
                  <MaxBid currencyID="CurrencyCodeType"> AmountType (double) </MaxBid>
                  <QuantityBid> int </QuantityBid>
                  <QuantityWon> int </QuantityWon>
                </BiddingDetails>
                <eBayNotes> string </eBayNotes>
                <ItemID> ItemIDType (string) </ItemID>
                <ListingDetails> ListingDetailsType
                  <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
                  <EndTime> dateTime </EndTime>
                  <StartTime> dateTime </StartTime>
                </ListingDetails>
                <ListingType> ListingTypeCodeType </ListingType>
                <PictureDetails> PictureDetailsType
                  <GalleryURL> anyURI </GalleryURL>
                </PictureDetails>
                <PrivateNotes> string </PrivateNotes>
                <Seller> UserType
                  <Email> string </Email>
                  <UserID> UserIDType (string) </UserID>
                </Seller>
                <SellingStatus> SellingStatusType
                  <BidCount> int </BidCount>
                  <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
                  <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
                </SellingStatus>
                <ShippingDetails> ShippingDetailsType
                  <ShippingServiceOptions> ShippingServiceOptionsType
                    <LocalPickup> boolean </LocalPickup>
                    <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
                  </ShippingServiceOptions>
                  <!-- ... more ShippingServiceOptions nodes allowed here ... -->
                  <ShippingType> ShippingTypeCodeType </ShippingType>
                </ShippingDetails>
                <Site> SiteCodeType </Site>
                <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
                <SubTitle> string </SubTitle>
                <Title> string </Title>
                <Variations> VariationsType
                  <Variation> VariationType
                    <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>
              </Item>
              <OrderLineItemID> string </OrderLineItemID>
              <PaidTime> dateTime </PaidTime>
              <PaisaPayID> string </PaisaPayID>
              <Platform> TransactionPlatformCodeType </Platform>
              <QuantityPurchased> int </QuantityPurchased>
              <ShippedTime> dateTime </ShippedTime>
              <Status> TransactionStatusType
                <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
              </Status>
              <TotalPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalPrice>
              <TotalTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalTransactionPrice>
              <TransactionID> string </TransactionID>
            </Transaction>
            <!-- ... more Transaction nodes allowed here ... -->
          </TransactionArray>
        </Order>
        <Transaction> TransactionType
          <BuyerPaidStatus> PaidStatusCodeType </BuyerPaidStatus>
          <CreatedDate> dateTime </CreatedDate>
          <FeedbackLeft> FeedbackInfoType
            <CommentType> CommentTypeCodeType </CommentType>
          </FeedbackLeft>
          <FeedbackReceived> FeedbackInfoType
            <CommentType> CommentTypeCodeType </CommentType>
          </FeedbackReceived>
          <Item> ItemType
            <BiddingDetails> BiddingDetailsType
              <ConvertedMaxBid currencyID="CurrencyCodeType"> AmountType (double) </ConvertedMaxBid>
              <MaxBid currencyID="CurrencyCodeType"> AmountType (double) </MaxBid>
              <QuantityBid> int </QuantityBid>
              <QuantityWon> int </QuantityWon>
            </BiddingDetails>
            <eBayNotes> string </eBayNotes>
            <ItemID> ItemIDType (string) </ItemID>
            <ListingDetails> ListingDetailsType
              <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
              <EndTime> dateTime </EndTime>
              <StartTime> dateTime </StartTime>
            </ListingDetails>
            <ListingType> ListingTypeCodeType </ListingType>
            <PictureDetails> PictureDetailsType
              <GalleryURL> anyURI </GalleryURL>
            </PictureDetails>
            <PrivateNotes> string </PrivateNotes>
            <Seller> UserType
              <Email> string </Email>
              <UserID> UserIDType (string) </UserID>
            </Seller>
            <SellingStatus> SellingStatusType
              <BidCount> int </BidCount>
              <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
              <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
            </SellingStatus>
            <ShippingDetails> ShippingDetailsType
              <ShippingServiceOptions> ShippingServiceOptionsType
                <LocalPickup> boolean </LocalPickup>
                <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
              </ShippingServiceOptions>
              <!-- ... more ShippingServiceOptions nodes allowed here ... -->
              <ShippingType> ShippingTypeCodeType </ShippingType>
            </ShippingDetails>
            <Site> SiteCodeType </Site>
            <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
            <SubTitle> string </SubTitle>
            <Title> string </Title>
            <Variations> VariationsType
              <Variation> VariationType
                <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>
          </Item>
          <OrderLineItemID> string </OrderLineItemID>
          <PaidTime> dateTime </PaidTime>
          <PaisaPayID> string </PaisaPayID>
          <Platform> TransactionPlatformCodeType </Platform>
          <QuantityPurchased> int </QuantityPurchased>
          <ShippedTime> dateTime </ShippedTime>
          <Status> TransactionStatusType
            <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
          </Status>
          <TotalPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalPrice>
          <TotalTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalTransactionPrice>
          <TransactionID> string </TransactionID>
        </Transaction>
      </OrderTransaction>
      <!-- ... more OrderTransaction nodes allowed here ... -->
    </OrderTransactionArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </WonList>
  <!-- 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>
</GetMyeBayBuyingResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
BestOfferList PaginatedItemArrayType Conditionally Contains the items the user has placed Best Offers on. Only returned if items exist that meet the request criteria.

DetailLevel: ReturnAll.
BestOfferList.ItemArray ItemArrayType Conditionally Contains a list of Item types.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.ItemArray.Item ItemType Conditionally,
repeatable: [0..*]		 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.
BestOfferList.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.
BestOfferList.ItemArray.Item
  .BestOfferDetails.BestOffer 		AmountType (double) Conditionally This is the amount of the buyer's current Best Offer. This field will not appear in the GetMyeBayBuying response if the buyer has not made a Best Offer.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.ItemArray.Item
  .BestOfferDetails.BestOffer
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BestOfferList.ItemArray.Item
  .BestOfferDetails
  .BestOfferStatus 		BestOfferStatusCodeType Conditionally This enumeration value indicates the status of the latest Best Offer from the buyer. This field will not appear in the GetMyeBayBuying response if the buyer has not made a Best Offer.

Applicable values:

•   Accepted

(out) Depending on context, this value can indicate that the buyer's Best offer was accepted by the seller, or that the seller's counter offer was accepted by the buyer.

•   Active

(in/out) Depending on context, this value can indicate that a buyer's Best Offer or a seller's counter offer is in the active state. The 'Active' value can also be used in the GetBestOffers request to retrieve only the Best Offers in the active state.

•   AdminEnded

(out) This value indicates that the Best Offer was ended by an eBay administrator.

•   All

(in/out) This value is used in the GetBestOffers request to retrieve all Best Offers in all states.

•   Countered

(out) This value indicates that a buyer's Best Offer has triggered a counter offer from the seller.

•   CustomCode

(out) Reserved for internal or future use.

•   Declined

(out) Depending on context, this value can indicate that the buyer's Best offer was declined by the seller, or that the seller's counter offer was declined by the buyer.

•   Expired

(out) Depending on context, this value can indicate that the buyer's Best Offer expired due to the passing of 48 hours with no seller response (accept, decline, counter offer), or that the seller's counter offer expired due to the passing of 48 hours with no buyer response (accept, decline, another Best Offer).

•   Pending

(out) This value indicates that the buyer's Best Offer on an item is awaiting the seller's response (accept, decline, counter offer). A buyer's Best Offer expires after 48 hours without a seller's response.

•   PendingBuyerConfirmation

(out) This value indicates that the seller is waiting on the buyer to commit to buying the item at the counter offer price.

•   PendingBuyerPayment

(out) This value indicates that the buyer has accepted the seller's counter offer, but the seller is still awaiting on payment from the buyer. If the buyer does not pay within 48 hours, the counter offer will expire.

•   Retracted

(out) Depending on context, this value can indicate that the buyer has retracted the Best Offer, or that the seller has retracted the counter offer.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.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. Also returned if DetailLevel is not provided on input.

See:
    Listing Policies
    Revising Items

BestOfferList.ItemArray.Item
  .BuyItNowPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BestOfferList.ItemArray.Item
  .eBayNotes 		string Conditionally Returns a note from eBay displayed below items in the user's My eBay account.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.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.
BestOfferList.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.
BestOfferList.ItemArray.Item
  .ListingDetails
  .ConvertedBuyItNowPrice 		AmountType (double) Conditionally Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.ItemArray.Item
  .ListingDetails
  .ConvertedBuyItNowPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BestOfferList.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.
BestOfferList.ItemArray.Item
  .PictureDetails 		PictureDetailsType Conditionally Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture.


Not applicable to Half.com.

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

See Introduction to Pictures in Item Listings.
BestOfferList.ItemArray.Item
  .PictureDetails.GalleryURL 		anyURI Conditionally Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing.

Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide.

(See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings.

Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name.
Max length: 1024.

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

See:
    Introduction to Pictures in Item Listings
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.
    (ReviseItem) DeletedField

BestOfferList.ItemArray.Item
  .PrivateNotes 		string Conditionally A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note.

Not supported as input in ReviseItem. Use SetUserNotes instead.

For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)
BestOfferList.ItemArray.Item
  .Seller 		UserType Conditionally Container for information about this listing's seller.

Not applicable to Half.com.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.ItemArray.Item
  .Seller.FeedbackRatingStar 		FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.ItemArray.Item
  .Seller.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
BestOfferList.ItemArray.Item
  .Seller.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
BestOfferList.ItemArray.Item
  .SellingStatus 		SellingStatusType Conditionally 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.
BestOfferList.ItemArray.Item
  .SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation 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.
BestOfferList.ItemArray.Item
  .SellingStatus
  .ConvertedCurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BestOfferList.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.
BestOfferList.ItemArray.Item
  .SellingStatus.CurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BestOfferList.ItemArray.Item
  .ShippingDetails 		ShippingDetailsType Conditionally The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs.

New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired.

For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout.

IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing.
Shipping details are not applicable to Real Estate listings and Half.com.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.)

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

See:
    Determining Shipping Costs for a Listing
    Revising Items for restrictions on changing item properties with ReviseItem

BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions 		ShippingServiceOptionsType Conditionally,
repeatable: [0..*]		 Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified.

For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs.

If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them:

<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>

If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.

A seller can offer up to four domestic shipping services and up to five international shipping services. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

Not applicable to Half.com or eBay Motors vehicle listings.

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

See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .LocalPickup 		boolean Conditionally The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option. The LocalPickup flag can also be used with other fields to indicate if there is no fee for local pickup. For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping.
BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost 		AmountType (double) Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse).

Also applicable to Half.com (for GetOrders).

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

See Determining Shipping Costs for a Listing.
BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BestOfferList.ItemArray.Item
  .ShippingDetails.ShippingType 		ShippingTypeCodeType Conditionally The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types.

GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these.

Not applicable to Half.com.

Applicable values:

•   Calculated

(in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts.

•   CalculatedDomesticFlatInternational

(in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services.

•   CustomCode

(in/out) Reserved for future use.

•   Flat

(in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.

•   FlatDomesticCalculatedInternational

(in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services.

•   FreightFlat

(in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item.

Currently, FreightFlat is available only for the US, UK, AU, CA and CAFR sites, and only for domestic shipping. On the US site, FreightFlat applies to shipping with carriers that are not affiliated with eBay. For details about freight shipping, see "Specifying Freight Shipping" in the Shipping chapter of the User's Guide.

•   NotSpecified

(in/out) The seller did not specify the shipping type.


(Not all values in ShippingTypeCodeType apply to this field.)
BestOfferList.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

BestOfferList.ItemArray.Item
  .SubTitle 		string Conditionally Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees).

Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle.

When you revise a item, you can add, change, or remove the subtitle.

Not applicable to Half.com.
Max length: 55.

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

See:
    Relisting Items
    (RelistItem) DeletedField
    Listing US and CA eBay Motors Items

BestOfferList.ItemArray.Item
  .TimeLeft 		duration Conditionally Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.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.
BestOfferList.PaginationResult PaginationResultType Conditionally Provides information about the list, including number of pages and number of entries.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.PaginationResult
  .TotalNumberOfEntries 		int Conditionally Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.PaginationResult
  .TotalNumberOfPages 		int Conditionally Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList PaginatedItemArrayType Conditionally Contains all the items the buyer has bid on. Only returned if items exist that meet the request criteria.

DetailLevel: ReturnAll.
BidList.ItemArray ItemArrayType Conditionally Contains a list of Item types.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item ItemType Conditionally,
repeatable: [0..*]		 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.
BidList.ItemArray.Item
  .BiddingDetails 		BiddingDetailsType Conditionally This container consists of information about the buyer's bidding history on a single auction item.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item
  .BiddingDetails
  .ConvertedMaxBid 		AmountType (double) Conditionally Converted value (from seller's currency to buyer's currency) of the amount in the MaxBid field. This field is only applicable and returned if the buyer purchased an item from an eBay site in another country. For active items, it is recommended to refresh the listing's data every 24 hours to pick up the current conversion rates.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item
  .BiddingDetails
  .ConvertedMaxBid
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.ItemArray.Item
  .BiddingDetails.MaxBid 		AmountType (double) Conditionally This value is the dollar value of the highest bid that the buyer placed on the auction item.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item
  .BiddingDetails.MaxBid
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.ItemArray.Item
  .BiddingDetails.QuantityBid 		int Conditionally This value is the total number of bids that the buyer placed on the auction item throughout the duration of the listing.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item
  .BiddingDetails.QuantityWon 		int Conditionally This field will only be returned if the buyer won the auction item, and if it is returned, its value will always be '1'.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.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. Also returned if DetailLevel is not provided on input.

See:
    Listing Policies
    Revising Items

BidList.ItemArray.Item
  .BuyItNowPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.ItemArray.Item
  .eBayNotes 		string Conditionally Returns a note from eBay displayed below items in the user's My eBay account.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.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.
BidList.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.
BidList.ItemArray.Item
  .ListingDetails
  .ConvertedBuyItNowPrice 		AmountType (double) Conditionally Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item
  .ListingDetails
  .ConvertedBuyItNowPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.ItemArray.Item
  .ListingDetails
  .ConvertedStartPrice 		AmountType (double) Conditionally Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation 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.
BidList.ItemArray.Item
  .ListingDetails
  .ConvertedStartPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.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.
BidList.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.
BidList.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.

•   Shopping

(out) Reserved for internal or future use. You can ignore Shopping.com items in your results.


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


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

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

BidList.ItemArray.Item
  .PictureDetails 		PictureDetailsType Conditionally Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture.


Not applicable to Half.com.

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

See Introduction to Pictures in Item Listings.
BidList.ItemArray.Item
  .PictureDetails.GalleryURL 		anyURI Conditionally Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing.

Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide.

(See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings.

Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name.
Max length: 1024.

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

See:
    Introduction to Pictures in Item Listings
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.
    (ReviseItem) DeletedField

BidList.ItemArray.Item
  .PrivateNotes 		string Conditionally A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note.

Not supported as input in ReviseItem. Use SetUserNotes instead.

For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)
BidList.ItemArray.Item.Seller UserType Conditionally Container for information about this listing's seller.

Not applicable to Half.com.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item.Seller
  .FeedbackRatingStar 		FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item.Seller
  .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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
BidList.ItemArray.Item.Seller
  .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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
BidList.ItemArray.Item
  .SellingStatus 		SellingStatusType Conditionally 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.
BidList.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.
BidList.ItemArray.Item
  .SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation 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.
BidList.ItemArray.Item
  .SellingStatus
  .ConvertedCurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.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.
BidList.ItemArray.Item
  .SellingStatus.CurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.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. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item
  .SellingStatus.HighBidder
  .FeedbackRatingStar 		FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
BidList.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
BidList.ItemArray.Item
  .SellingStatus.ReserveMet 		boolean Conditionally Indicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item
  .ShippingDetails 		ShippingDetailsType Conditionally The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs.

New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired.

For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout.

IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing.
Shipping details are not applicable to Real Estate listings and Half.com.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.)

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

See:
    Determining Shipping Costs for a Listing
    Revising Items for restrictions on changing item properties with ReviseItem

BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions 		ShippingServiceOptionsType Conditionally,
repeatable: [0..*]		 Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified.

For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs.

If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them:

<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>

If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.

A seller can offer up to four domestic shipping services and up to five international shipping services. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

Not applicable to Half.com or eBay Motors vehicle listings.

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

See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .LocalPickup 		boolean Conditionally The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option. The LocalPickup flag can also be used with other fields to indicate if there is no fee for local pickup. For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping.
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost 		AmountType (double) Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse).

Also applicable to Half.com (for GetOrders).

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

See Determining Shipping Costs for a Listing.
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge 		AmountType (double) Conditionally An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.ItemArray.Item
  .ShippingDetails.ShippingType 		ShippingTypeCodeType Conditionally The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types.

GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these.

Not applicable to Half.com.

Applicable values:

•   Calculated

(in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts.

•   CalculatedDomesticFlatInternational

(in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services.

•   CustomCode

(in/out) Reserved for future use.

•   Flat

(in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.

•   FlatDomesticCalculatedInternational

(in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services.

•   FreightFlat

(in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item.

Currently, FreightFlat is available only for the US, UK, AU, CA and CAFR sites, and only for domestic shipping. On the US site, FreightFlat applies to shipping with carriers that are not affiliated with eBay. For details about freight shipping, see "Specifying Freight Shipping" in the Shipping chapter of the User's Guide.

•   NotSpecified

(in/out) The seller did not specify the shipping type.


(Not all values in ShippingTypeCodeType apply to this field.)
BidList.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

BidList.ItemArray.Item
  .StartPrice 		AmountType (double) Conditionally This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For fixed-price listings: This is the fixed-price at which a buyer may purchase the item.

For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types.

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. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice.

For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead.

Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings.

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

See Listing Policies.
BidList.ItemArray.Item
  .StartPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.ItemArray.Item
  .SubTitle 		string Conditionally Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees).

Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle.

When you revise a item, you can add, change, or remove the subtitle.

Not applicable to Half.com.
Max length: 55.

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

See:
    Relisting Items
    (RelistItem) DeletedField
    Listing US and CA eBay Motors Items

BidList.ItemArray.Item
  .TimeLeft 		duration Conditionally Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.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.
BidList.PaginationResult PaginationResultType Conditionally Provides information about the list, including number of pages and number of entries.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.PaginationResult
  .TotalNumberOfEntries 		int Conditionally Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.PaginationResult
  .TotalNumberOfPages 		int Conditionally Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BuyingSummary BuyingSummaryType Always Contains a summary of the items the user has bid on. Returned at all detail levels.

DetailLevel: ReturnAll.
BuyingSummary.BestOfferCount int Conditionally The number of items the user has made Best Offers on.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BuyingSummary.BiddingCount int Conditionally The number of auction items the user has bid on.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BuyingSummary.TotalWinningCost AmountType (double) Conditionally The total cost of items the user is presently winning.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BuyingSummary.TotalWinningCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BuyingSummary.TotalWonCost AmountType (double) Conditionally The total cost of items the user has bid on and won.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BuyingSummary.TotalWonCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
BuyingSummary.WinningCount int Conditionally The number of auction items the user has bid on and is winning, but auctions have not yet ended.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BuyingSummary.WonCount int Conditionally The number of items the user has bid on and won.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BuyingSummary
  .WonDurationInDays 		int Conditionally The time period for which won items are displayed. Default is 31 days.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList PaginatedItemArrayType Conditionally Contains the items the buyer has bid on, lost, and deleted from My eBay. Only returned if items exist that meet the request criteria.

DetailLevel: ReturnAll.
DeletedFromLostList.ItemArray ItemArrayType Conditionally Contains a list of Item types.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.ItemArray
  .Item 		ItemType Conditionally,
repeatable: [0..*]		 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.
DeletedFromLostList.ItemArray
  .Item.BiddingDetails 		BiddingDetailsType Conditionally This container consists of information about the buyer's bidding history on a single auction item.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.ItemArray
  .Item.BiddingDetails
  .ConvertedMaxBid 		AmountType (double) Conditionally Converted value (from seller's currency to buyer's currency) of the amount in the MaxBid field. This field is only applicable and returned if the buyer purchased an item from an eBay site in another country. For active items, it is recommended to refresh the listing's data every 24 hours to pick up the current conversion rates.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.ItemArray
  .Item.BiddingDetails
  .ConvertedMaxBid
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromLostList.ItemArray
  .Item.BiddingDetails.MaxBid 		AmountType (double) Conditionally This value is the dollar value of the highest bid that the buyer placed on the auction item.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.ItemArray
  .Item.BiddingDetails.MaxBid
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromLostList.ItemArray
  .Item.BiddingDetails
  .QuantityBid 		int Conditionally This value is the total number of bids that the buyer placed on the auction item throughout the duration of the listing.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.ItemArray
  .Item.BiddingDetails
  .QuantityWon 		int Conditionally This field will only be returned if the buyer won the auction item, and if it is returned, its value will always be '1'.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.ItemArray
  .Item.eBayNotes 		string Conditionally Returns a note from eBay displayed below items in the user's My eBay account.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.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.
DeletedFromLostList.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.
DeletedFromLostList.ItemArray
  .Item.ListingDetails
  .ConvertedStartPrice 		AmountType (double) Conditionally Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation 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.
DeletedFromLostList.ItemArray
  .Item.ListingDetails
  .ConvertedStartPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromLostList.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.
DeletedFromLostList.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.
DeletedFromLostList.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.

•   Shopping

(out) Reserved for internal or future use. You can ignore Shopping.com items in your results.


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


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

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

DeletedFromLostList.ItemArray
  .Item.PictureDetails 		PictureDetailsType Conditionally Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture.


Not applicable to Half.com.

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

See Introduction to Pictures in Item Listings.
DeletedFromLostList.ItemArray
  .Item.PictureDetails
  .GalleryURL 		anyURI Conditionally Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing.

Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide.

(See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings.

Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name.
Max length: 1024.

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

See:
    Introduction to Pictures in Item Listings
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.
    (ReviseItem) DeletedField

DeletedFromLostList.ItemArray
  .Item.PrivateNotes 		string Conditionally A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note.

Not supported as input in ReviseItem. Use SetUserNotes instead.

For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)
DeletedFromLostList.ItemArray
  .Item.Seller 		UserType Conditionally Container for information about this listing's seller.

Not applicable to Half.com.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.ItemArray
  .Item.Seller
  .FeedbackRatingStar 		FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.ItemArray
  .Item.Seller.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
DeletedFromLostList.ItemArray
  .Item.Seller.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
DeletedFromLostList.ItemArray
  .Item.SellingStatus 		SellingStatusType Conditionally 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.
DeletedFromLostList.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.
DeletedFromLostList.ItemArray
  .Item.SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation 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.
DeletedFromLostList.ItemArray
  .Item.SellingStatus
  .ConvertedCurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromLostList.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.
DeletedFromLostList.ItemArray
  .Item.SellingStatus
  .CurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromLostList.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. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.ItemArray
  .Item.SellingStatus.HighBidder
  .FeedbackRatingStar 		FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
DeletedFromLostList.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
DeletedFromLostList.ItemArray
  .Item.ShippingDetails 		ShippingDetailsType Conditionally The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs.

New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired.

For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout.

IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing.
Shipping details are not applicable to Real Estate listings and Half.com.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.)

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

See:
    Determining Shipping Costs for a Listing
    Revising Items for restrictions on changing item properties with ReviseItem

DeletedFromLostList.ItemArray
  .Item.ShippingDetails
  .ShippingType 		ShippingTypeCodeType Conditionally The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types.

GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these.

Not applicable to Half.com.

Applicable values:

•   Calculated

(in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts.

•   CalculatedDomesticFlatInternational

(in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services.

•   CustomCode

(in/out) Reserved for future use.

•   Flat

(in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.

•   FlatDomesticCalculatedInternational

(in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services.

•   FreightFlat

(in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item.

Currently, FreightFlat is available only for the US, UK, AU, CA and CAFR sites, and only for domestic shipping. On the US site, FreightFlat applies to shipping with carriers that are not affiliated with eBay. For details about freight shipping, see "Specifying Freight Shipping" in the Shipping chapter of the User's Guide.

•   NotSpecified

(in/out) The seller did not specify the shipping type.


(Not all values in ShippingTypeCodeType apply to this field.)
DeletedFromLostList.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

DeletedFromLostList.ItemArray
  .Item.StartPrice 		AmountType (double) Conditionally This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For fixed-price listings: This is the fixed-price at which a buyer may purchase the item.

For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types.

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. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice.

For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead.

Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings.

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

See Listing Policies.
DeletedFromLostList.ItemArray
  .Item.StartPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromLostList.ItemArray
  .Item.SubTitle 		string Conditionally Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees).

Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle.

When you revise a item, you can add, change, or remove the subtitle.

Not applicable to Half.com.
Max length: 55.

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

See:
    Relisting Items
    (RelistItem) DeletedField
    Listing US and CA eBay Motors Items

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

DeletedFromLostList.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.
DeletedFromLostList.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.
DeletedFromLostList.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.
DeletedFromLostList
  .PaginationResult 		PaginationResultType Conditionally Provides information about the list, including number of pages and number of entries.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList
  .PaginationResult
  .TotalNumberOfEntries 		int Conditionally Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList
  .PaginationResult
  .TotalNumberOfPages 		int Conditionally Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList PaginatedOrderTransactionArrayType Conditionally Contains the items the buyer has bid on, won, and deleted from My eBay. Only returned if items exist that meet the request criteria.

DetailLevel: ReturnAll.
DeletedFromWonList
  .OrderTransactionArray 		OrderTransactionArrayType Conditionally Contains the list of orders.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction 		OrderTransactionType Conditionally,
repeatable: [0..*]		 The individual order or transaction.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order 		OrderType Conditionally Contains the information describing an order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .OrderID 		OrderIDType (string) Conditionally A unique identifier that identifies a single line item or multiple line item order.

For a single line item order, the OrderID value is identical to the OrderLineItemID value that is generated upon creation of the order line item. For a Combined Payment order or an order that goes through the eBay shopping cart flow, the OrderID value is automatically created by eBay. A Combined Payment order can be created through the site by a buyer or seller when the buyer or seller share multiple, common order line items. A Combined Payment order can also be created by the seller through the AddOrder call.

An OrderID value overrides an OrderLineItemID value or an ItemID/TransactionID pair if these fields are also specified in the same request.

Also applicable to Half.com (for GetOrders).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .Subtotal 		AmountType (double) Conditionally The subtotal amount for the order is the total cost of all order line items. This value does not include any shipping/handling, shipping insurance, or sales tax costs.

Applicable to Half.com (for GetOrders).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .Subtotal
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray 		TransactionArrayType Conditionally Container consisting of one or more line items that comprise an order. The data for an order line item is stored in the Transaction container. For the AddOrder call, there will always be at least two order line items in the container, but no more than 40.

We strongly recommend that you avoid mixing transactions for digital and non-digital listings in the same Combined Payment order. (In the future, AddOrder may enforce this recommendation.)

Applicable to Half.com (for GetOrders).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction 		TransactionType Conditionally,
repeatable: [0..*]		 The Transaction container consists of detailed information on one order line item. Also applicable to Half.com (for GetOrders).

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

See Listing an Item.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .BuyerPaidStatus 		PaidStatusCodeType Conditionally This value indicates the payment status of an order. This field is only returned for items that have actually been purchased (fixed-price or Buy It Now) or won (auction listings) and not auction listings that have just been bid on.

Not applicable to Half.com.

Applicable values:

•   BuyerHasNotCompletedCheckout

(out) The buyer has not completed the checkout process and so has not made payment.

•   CustomCode

(out) Reserved for future use.

•   EscrowPaymentCancelled

(out) The buyer has made an escrow payment, but has cancelled the payment.

•   MarkedAsPaid

(out) The order is marked as paid by either buyer or seller.

•   NotPaid

(out) The buyer has not completed checkout, but has not paid through PayPal or PaisaPay (but please also see the documentation for PaymentHoldStatus and its applicable values). The buyer might have paid using another method, but the payment might not have been received or cleared. Important: Please see the documentation for PaymentHoldStatus and its applicable values. PaymentHoldStatus contains the current status of a hold on a PayPal payment.

•   Paid

(out) Paid

•   PaidCOD

(out) PaidCOD

•   PaidWithEscrow

(out) The buyer has made an escrow payment, and the seller has received payment.

•   PaidWithPaisaPay

(out) The buyer has paid with PaisaPay, and the payment is complete.

•   PaidWithPaisaPayEscrow

(out) Paid With PaisaPay Escrow

•   PaidWithPayPal

(out) The buyer has made a PayPal payment, and the payment is complete. But please also see the documentation for PaymentHoldStatus and its applicable values. PaymentHoldStatus contains the current status of a hold on a PayPal payment.

•   PaisaPayNotPaid

(out) Paisa Pay Not Paid

•   PaymentPending

(out) The buyer has made a payment other than PayPal, escrow, or PaisaPay, but the payment is still being processed.

•   PaymentPendingWithEscrow

(out) The buyer has made an escrow payment, but the seller has not yet received it.

•   PaymentPendingWithPaisaPay

(out) The buyer has paid with PaisaPay, but the payment is still being processed. The seller has not yet received payment.

•   PaymentPendingWithPaisaPayEscrow

(out) Payment Pending With PaisaPay Escrow

•   PaymentPendingWithPayPal

(out) The buyer has made a PayPal payment, but the seller has not yet received it.

•   Refunded

(out) Refunded

•   WaitingForCODPayment

(out) WaitingForCODPayment




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .CreatedDate 		dateTime Conditionally Indicates the creation time of the order line item. For auction listings, an order line item is created when that listing ends with a high bidder whose bid meets or exceeds the Reserve Price (if set). For a fixed-price listing or a Buy It Now auction listing, an order line item is created once the buyer clicks the Buy button.

Applicable to Half.com (for GetOrders only).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .FeedbackLeft 		FeedbackInfoType Conditionally This container consists of Feedback left by the caller for their order partner. This container is only returned if the order is complete and feedback on the order line item has been left by the caller.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .FeedbackLeft.CommentType 		CommentTypeCodeType Conditionally This value indicates the Feedback rating for the user specified in the TargetUser field. This field is required in CompleteSale if the FeedbackInfo container is used.

A Positive rating increases the user's Feedback score, a Negative rating decreases the user's Feedback score, and a Neutral rating does not affect the user's Feedback score. eBay users also have the right to withdraw feedback for whatever reason.

Sellers cannot leave Neutral or Negative ratings for buyers.

Applicable values:

•   CustomCode

(in/out) This value is reserved for internal or future use.

•   IndependentlyWithdrawn

(in/out) This value indicates that a submitted Feedback entry was withdrawn based on the decision of a third-party (such as eBay). If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified.

This value is only applicable to the eBay Motors site only.

•   Negative

(in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Negative" experience. If an eBay user receives a Negative rating for an order line item from a Verified User, their overall Feedback score decreases by a value of 1.

•   Neutral

(in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Neutral" experience. If an eBay user receives a Neutral rating for an order line item from a Verified User, their overall Feedback score remains the same.

•   Positive

(in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Positive" experience. If an eBay user receives a Positive rating for an order line item from a Verified User, their overall Feedback score increases by a value of 1.

•   Withdrawn

(in/out) This value indicates that a submitted Feedback entry was withdrawn. If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. However, Feedback comments from the withdrawn entry are still visible.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .FeedbackReceived 		FeedbackInfoType Conditionally This container consists of Feedback received by the caller from their order partner. This container is only returned if the order is complete and feedback on the order line item has been received by the caller.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .FeedbackReceived.CommentType 		CommentTypeCodeType Conditionally This value indicates the Feedback rating for the user specified in the TargetUser field. This field is required in CompleteSale if the FeedbackInfo container is used.

A Positive rating increases the user's Feedback score, a Negative rating decreases the user's Feedback score, and a Neutral rating does not affect the user's Feedback score. eBay users also have the right to withdraw feedback for whatever reason.

Sellers cannot leave Neutral or Negative ratings for buyers.

Applicable values:

•   CustomCode

(in/out) This value is reserved for internal or future use.

•   IndependentlyWithdrawn

(in/out) This value indicates that a submitted Feedback entry was withdrawn based on the decision of a third-party (such as eBay). If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified.

This value is only applicable to the eBay Motors site only.

•   Negative

(in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Negative" experience. If an eBay user receives a Negative rating for an order line item from a Verified User, their overall Feedback score decreases by a value of 1.

•   Neutral

(in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Neutral" experience. If an eBay user receives a Neutral rating for an order line item from a Verified User, their overall Feedback score remains the same.

•   Positive

(in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Positive" experience. If an eBay user receives a Positive rating for an order line item from a Verified User, their overall Feedback score increases by a value of 1.

•   Withdrawn

(in/out) This value indicates that a submitted Feedback entry was withdrawn. If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. However, Feedback comments from the withdrawn entry are still visible.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item 		ItemType Conditionally Container consisting of details about an item in a listing. The child fields returned are dependent on the call, the type of item or listing, and the listing site.

Applicable to Half.com (for GetOrders).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.BiddingDetails 		BiddingDetailsType Conditionally This container consists of information about the buyer's bidding history on a single auction item.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.BiddingDetails
  .ConvertedMaxBid 		AmountType (double) Conditionally Converted value (from seller's currency to buyer's currency) of the amount in the MaxBid field. This field is only applicable and returned if the buyer purchased an item from an eBay site in another country. For active items, it is recommended to refresh the listing's data every 24 hours to pick up the current conversion rates.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.BiddingDetails
  .ConvertedMaxBid
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.BiddingDetails.MaxBid 		AmountType (double) Conditionally This value is the dollar value of the highest bid that the buyer placed on the auction item.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.BiddingDetails.MaxBid
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.BiddingDetails
  .QuantityBid 		int Conditionally This value is the total number of bids that the buyer placed on the auction item throughout the duration of the listing.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.BiddingDetails
  .QuantityWon 		int Conditionally This field will only be returned if the buyer won the auction item, and if it is returned, its value will always be '1'.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.eBayNotes 		string Conditionally Returns a note from eBay displayed below items in the user's My eBay account.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ListingDetails
  .ConvertedStartPrice 		AmountType (double) Conditionally Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation 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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ListingDetails
  .ConvertedStartPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.

•   Shopping

(out) Reserved for internal or future use. You can ignore Shopping.com items in your results.


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


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

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

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.PictureDetails 		PictureDetailsType Conditionally Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture.


Not applicable to Half.com.

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

See Introduction to Pictures in Item Listings.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.PictureDetails
  .GalleryURL 		anyURI Conditionally Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing.

Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide.

(See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings.

Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name.
Max length: 1024.

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

See:
    Introduction to Pictures in Item Listings
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.
    (ReviseItem) DeletedField

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.PrivateNotes 		string Conditionally A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note.

Not supported as input in ReviseItem. Use SetUserNotes instead.

For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Seller 		UserType Conditionally Container for information about this listing's seller.

Not applicable to Half.com.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Seller.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. Also returned if DetailLevel is not provided on input.

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

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Seller.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellingStatus 		SellingStatusType Conditionally 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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation 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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellingStatus
  .ConvertedCurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellingStatus
  .CurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails 		ShippingDetailsType Conditionally The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs.

New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired.

For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout.

IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing.
Shipping details are not applicable to Real Estate listings and Half.com.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.)

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

See:
    Determining Shipping Costs for a Listing
    Revising Items for restrictions on changing item properties with ReviseItem

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions 		ShippingServiceOptionsType Conditionally,
repeatable: [0..*]		 Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified.

For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs.

If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them:

<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>

If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.

A seller can offer up to four domestic shipping services and up to five international shipping services. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

Not applicable to Half.com or eBay Motors vehicle listings.

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

See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .LocalPickup 		boolean Conditionally The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option. The LocalPickup flag can also be used with other fields to indicate if there is no fee for local pickup. For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost 		AmountType (double) Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse).

Also applicable to Half.com (for GetOrders).

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

See Determining Shipping Costs for a Listing.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingType 		ShippingTypeCodeType Conditionally The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types.

GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these.

Not applicable to Half.com.

Applicable values:

•   Calculated

(in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts.

•   CalculatedDomesticFlatInternational

(in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services.

•   CustomCode

(in/out) Reserved for future use.

•   Flat

(in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.

•   FlatDomesticCalculatedInternational

(in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services.

•   FreightFlat

(in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item.

Currently, FreightFlat is available only for the US, UK, AU, CA and CAFR sites, and only for domestic shipping. On the US site, FreightFlat applies to shipping with carriers that are not affiliated with eBay. For details about freight shipping, see "Specifying Freight Shipping" in the Shipping chapter of the User's Guide.

•   NotSpecified

(in/out) The seller did not specify the shipping type.


(Not all values in ShippingTypeCodeType apply to this field.)
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.StartPrice 		AmountType (double) Conditionally This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For fixed-price listings: This is the fixed-price at which a buyer may purchase the item.

For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types.

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. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice.

For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead.

Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings.

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

See Listing Policies.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.StartPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SubTitle 		string Conditionally Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees).

Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle.

When you revise a item, you can add, change, or remove the subtitle.

Not applicable to Half.com.
Max length: 55.

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

See:
    Relisting Items
    (RelistItem) DeletedField
    Listing US and CA eBay Motors Items

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .OrderLineItemID 		string Always A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs.
Max length: 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .PaidTime 		dateTime Conditionally Indicates the time when the order was marked paid. This value will only be visible to the user on either side of the order. An order can be marked as paid in the following ways:
  • Automatically when a payment is made via PayPal
  • Seller marks the item as paid in My eBay or through Selling Manager Pro
  • Programmatically by the seller through the ReviseCheckoutStatus or CompleteSale calls.


Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .PaisaPayID 		string Conditionally Unique identifier for a PaisaPay transaction. Only applicable for the India site (203) if PaisaPay was the payment method used.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Platform 		TransactionPlatformCodeType Conditionally Name of the eBay co-branded site upon which the order line item (transaction) was created.

Applicable values:

•   CustomCode

(in/out) Reserved for future use.

•   eBay

(in/out) The order line item was created on the main eBay site.

•   Express

(in/out) The order line item was created on the eBay Express site.

•   Half

(in/out) The order line item was created on Half.com site.

•   Shopping

(in/out) The order line item was created on the Shopping.com site.

•   WorldOfGood

(in/out) The order line item was created on the WorldOfGood site.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .QuantityPurchased 		int Conditionally This value indicates the number of identical items purchased at the same time by the same buyer from one listing. For auction listings, this value is always 1. For fixed-price, non-variation listings, this value can be greater than 1. In either case, this field is tied to the same order line item.

Applicable to Half.com (for GetOrders).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .ShippedTime 		dateTime Conditionally Indicates the time when the item(s) associated with the order were marked as shipped. This value will only be visible to the user on either side of the order. An order can be marked as shipped in My eBay or through Selling Manager Pro, or programmatically by the seller through the CompleteSale call.

Applicable to Half.com (for GetOrders only).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Status 		TransactionStatusType Conditionally Container consisting of status details of an order line item, including payment information. Several of these fields change values during the checkout flow. See TransactionStatusType for its child elements.

For GetOrders, only the IntegratedMerchantCreditCardEnabled and PaymentMethodUsed child elements are returned. The PaymentHoldStatus container will be returned for those sellers subject to the new eBay payment process. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Status.PaymentHoldStatus 		PaymentHoldStatusCodeType Conditionally This field indicates the type and/or status of a payment hold on the item.

Applicable values:

•   CustomCode

(out) This value is reserved for internal or future use.

•   MerchantHold

(out) This value indicates a possible issue with a seller. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as PaidWithPayPal in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying.

•   NewSellerHold

(out) This value indicates that there is a "new seller hold" on the item. PayPal may hold payments to a new seller for up to 21 days. Sellers are considered "new" until they have met all three criteria below:

  • More than 90 days have passed since first successful sale
  • More than 25 domestic sales
  • More than $250.00 in total sales

•   None

(out) This value indicates that there is no payment hold on the item.

•   PaymentHold

(out) This value indicates that there is a payment hold on the item.

•   PaymentReview

(out) This value indicates a possible issue with a buyer. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as NotPaid in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying.

•   ReleaseConfirmed

(out) This value indicates that the funds are available in the seller's PayPal account.

•   Released

(out) This value indicates that a payment hold on the item has been released.

•   ReleasePending

(out) This value indicates that the process for the release of funds for the order has been initiated.




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

See Holds on PayPal Payments.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .TotalPrice 		AmountType (double) Conditionally This field indicates the total price for an order line item.

For GetMyeBaySelling, with Global Shipping Program orders, the value of this field depends on order status and the number of transactions in the order. For orders awaiting payment, the field contains the purchase price of the order line item; for paid orders, it contains the purchase price of the order line item plus the cost of domestic shipping to the international shipping provider's warehouse. With single-transaction orders, this field is returned under the OrderTransaction.Transaction container; with multiple-transaction orders, it's returned under the OrderTransaction.Order.TransactionArray.Transaction container.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .TotalPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .TotalTransactionPrice 		AmountType (double) Conditionally The price of one order line item. This amount does not take into account shipping, sales tax, and other costs related to the order line item.

If multiple units were purchased through a non-variation, fixed-price listing, this value is the total combined price for all units of the order line item. With GetMyeBaySelling, you can also get this value by multiplying SellingStatus.QuantitySold by SellingStatus.CurrentPrice.

For eBay Motors Vehicle listings, TotalTransactionPrice is the deposit amount.

Applicable to Half.com (for GetOrders).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .TotalTransactionPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .TransactionID 		string Conditionally Unique identifier for an eBay order line item. An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the TransactionID for auction listings is always 0. Along with its corresponding ItemID, a TransactionID is used and referenced during an order checkout flow and after checkout has been completed.

Applicable to Half.com (for GetOrders only).
Max length: 19 (Note: The eBay database specifies 38. Transaction IDs are usually 9 to 12 digits.).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction 		TransactionType Conditionally Contains the information describing a transaction.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .BuyerPaidStatus 		PaidStatusCodeType Conditionally This value indicates the payment status of an order. This field is only returned for items that have actually been purchased (fixed-price or Buy It Now) or won (auction listings) and not auction listings that have just been bid on.

Not applicable to Half.com.

Applicable values:

•   BuyerHasNotCompletedCheckout

(out) The buyer has not completed the checkout process and so has not made payment.

•   CustomCode

(out) Reserved for future use.

•   EscrowPaymentCancelled

(out) The buyer has made an escrow payment, but has cancelled the payment.

•   MarkedAsPaid

(out) The order is marked as paid by either buyer or seller.

•   NotPaid

(out) The buyer has not completed checkout, but has not paid through PayPal or PaisaPay (but please also see the documentation for PaymentHoldStatus and its applicable values). The buyer might have paid using another method, but the payment might not have been received or cleared. Important: Please see the documentation for PaymentHoldStatus and its applicable values. PaymentHoldStatus contains the current status of a hold on a PayPal payment.

•   Paid

(out) Paid

•   PaidCOD

(out) PaidCOD

•   PaidWithEscrow

(out) The buyer has made an escrow payment, and the seller has received payment.

•   PaidWithPaisaPay

(out) The buyer has paid with PaisaPay, and the payment is complete.

•   PaidWithPaisaPayEscrow

(out) Paid With PaisaPay Escrow

•   PaidWithPayPal

(out) The buyer has made a PayPal payment, and the payment is complete. But please also see the documentation for PaymentHoldStatus and its applicable values. PaymentHoldStatus contains the current status of a hold on a PayPal payment.

•   PaisaPayNotPaid

(out) Paisa Pay Not Paid

•   PaymentPending

(out) The buyer has made a payment other than PayPal, escrow, or PaisaPay, but the payment is still being processed.

•   PaymentPendingWithEscrow

(out) The buyer has made an escrow payment, but the seller has not yet received it.

•   PaymentPendingWithPaisaPay

(out) The buyer has paid with PaisaPay, but the payment is still being processed. The seller has not yet received payment.

•   PaymentPendingWithPaisaPayEscrow

(out) Payment Pending With PaisaPay Escrow

•   PaymentPendingWithPayPal

(out) The buyer has made a PayPal payment, but the seller has not yet received it.

•   Refunded

(out) Refunded

•   WaitingForCODPayment

(out) WaitingForCODPayment




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .CreatedDate 		dateTime Conditionally Indicates the creation time of the order line item. For auction listings, an order line item is created when that listing ends with a high bidder whose bid meets or exceeds the Reserve Price (if set). For a fixed-price listing or a Buy It Now auction listing, an order line item is created once the buyer clicks the Buy button.

Applicable to Half.com (for GetOrders only).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .FeedbackLeft 		FeedbackInfoType Conditionally This container consists of Feedback left by the caller for their order partner. This container is only returned if the order is complete and feedback on the order line item has been left by the caller.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .FeedbackLeft.CommentType 		CommentTypeCodeType Conditionally This value indicates the Feedback rating for the user specified in the TargetUser field. This field is required in CompleteSale if the FeedbackInfo container is used.

A Positive rating increases the user's Feedback score, a Negative rating decreases the user's Feedback score, and a Neutral rating does not affect the user's Feedback score. eBay users also have the right to withdraw feedback for whatever reason.

Sellers cannot leave Neutral or Negative ratings for buyers.

Applicable values:

•   CustomCode

(in/out) This value is reserved for internal or future use.

•   IndependentlyWithdrawn

(in/out) This value indicates that a submitted Feedback entry was withdrawn based on the decision of a third-party (such as eBay). If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified.

This value is only applicable to the eBay Motors site only.

•   Negative

(in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Negative" experience. If an eBay user receives a Negative rating for an order line item from a Verified User, their overall Feedback score decreases by a value of 1.

•   Neutral

(in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Neutral" experience. If an eBay user receives a Neutral rating for an order line item from a Verified User, their overall Feedback score remains the same.

•   Positive

(in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Positive" experience. If an eBay user receives a Positive rating for an order line item from a Verified User, their overall Feedback score increases by a value of 1.

•   Withdrawn

(in/out) This value indicates that a submitted Feedback entry was withdrawn. If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. However, Feedback comments from the withdrawn entry are still visible.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .FeedbackReceived 		FeedbackInfoType Conditionally This container consists of Feedback received by the caller from their order partner. This container is only returned if the order is complete and feedback on the order line item has been received by the caller.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .FeedbackReceived.CommentType 		CommentTypeCodeType Conditionally This value indicates the Feedback rating for the user specified in the TargetUser field. This field is required in CompleteSale if the FeedbackInfo container is used.

A Positive rating increases the user's Feedback score, a Negative rating decreases the user's Feedback score, and a Neutral rating does not affect the user's Feedback score. eBay users also have the right to withdraw feedback for whatever reason.

Sellers cannot leave Neutral or Negative ratings for buyers.

Applicable values:

•   CustomCode

(in/out) This value is reserved for internal or future use.

•   IndependentlyWithdrawn

(in/out) This value indicates that a submitted Feedback entry was withdrawn based on the decision of a third-party (such as eBay). If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified.

This value is only applicable to the eBay Motors site only.

•   Negative

(in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Negative" experience. If an eBay user receives a Negative rating for an order line item from a Verified User, their overall Feedback score decreases by a value of 1.

•   Neutral

(in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Neutral" experience. If an eBay user receives a Neutral rating for an order line item from a Verified User, their overall Feedback score remains the same.

•   Positive

(in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Positive" experience. If an eBay user receives a Positive rating for an order line item from a Verified User, their overall Feedback score increases by a value of 1.

•   Withdrawn

(in/out) This value indicates that a submitted Feedback entry was withdrawn. If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. However, Feedback comments from the withdrawn entry are still visible.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item 		ItemType Conditionally Container consisting of details about an item in a listing. The child fields returned are dependent on the call, the type of item or listing, and the listing site.

Applicable to Half.com (for GetOrders).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.BiddingDetails 		BiddingDetailsType Conditionally This container consists of information about the buyer's bidding history on a single auction item.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.BiddingDetails
  .ConvertedMaxBid 		AmountType (double) Conditionally Converted value (from seller's currency to buyer's currency) of the amount in the MaxBid field. This field is only applicable and returned if the buyer purchased an item from an eBay site in another country. For active items, it is recommended to refresh the listing's data every 24 hours to pick up the current conversion rates.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.BiddingDetails
  .ConvertedMaxBid
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.BiddingDetails.MaxBid 		AmountType (double) Conditionally This value is the dollar value of the highest bid that the buyer placed on the auction item.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.BiddingDetails.MaxBid
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.BiddingDetails
  .QuantityBid 		int Conditionally This value is the total number of bids that the buyer placed on the auction item throughout the duration of the listing.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.BiddingDetails
  .QuantityWon 		int Conditionally This field will only be returned if the buyer won the auction item, and if it is returned, its value will always be '1'.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.eBayNotes 		string Conditionally Returns a note from eBay displayed below items in the user's My eBay account.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ListingDetails
  .ConvertedStartPrice 		AmountType (double) Conditionally Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation 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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ListingDetails
  .ConvertedStartPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.

•   Shopping

(out) Reserved for internal or future use. You can ignore Shopping.com items in your results.


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


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

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

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.PictureDetails 		PictureDetailsType Conditionally Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture.


Not applicable to Half.com.

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

See Introduction to Pictures in Item Listings.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.PictureDetails
  .GalleryURL 		anyURI Conditionally Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing.

Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide.

(See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings.

Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name.
Max length: 1024.

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

See:
    Introduction to Pictures in Item Listings
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.
    (ReviseItem) DeletedField

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.PrivateNotes 		string Conditionally A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note.

Not supported as input in ReviseItem. Use SetUserNotes instead.

For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Seller 		UserType Conditionally Container for information about this listing's seller.

Not applicable to Half.com.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Seller.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. Also returned if DetailLevel is not provided on input.

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

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Seller.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SellingStatus 		SellingStatusType Conditionally 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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation 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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SellingStatus
  .ConvertedCurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SellingStatus
  .CurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails 		ShippingDetailsType Conditionally The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs.

New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired.

For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout.

IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing.
Shipping details are not applicable to Real Estate listings and Half.com.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.)

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

See:
    Determining Shipping Costs for a Listing
    Revising Items for restrictions on changing item properties with ReviseItem

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions 		ShippingServiceOptionsType Conditionally,
repeatable: [0..*]		 Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified.

For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs.

If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them:

<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>

If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.

A seller can offer up to four domestic shipping services and up to five international shipping services. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

Not applicable to Half.com or eBay Motors vehicle listings.

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

See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .LocalPickup 		boolean Conditionally The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option. The LocalPickup flag can also be used with other fields to indicate if there is no fee for local pickup. For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost 		AmountType (double) Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse).

Also applicable to Half.com (for GetOrders).

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

See Determining Shipping Costs for a Listing.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingType 		ShippingTypeCodeType Conditionally The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types.

GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these.

Not applicable to Half.com.

Applicable values:

•   Calculated

(in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts.

•   CalculatedDomesticFlatInternational

(in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services.

•   CustomCode

(in/out) Reserved for future use.

•   Flat

(in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.

•   FlatDomesticCalculatedInternational

(in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services.

•   FreightFlat

(in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item.

Currently, FreightFlat is available only for the US, UK, AU, CA and CAFR sites, and only for domestic shipping. On the US site, FreightFlat applies to shipping with carriers that are not affiliated with eBay. For details about freight shipping, see "Specifying Freight Shipping" in the Shipping chapter of the User's Guide.

•   NotSpecified

(in/out) The seller did not specify the shipping type.


(Not all values in ShippingTypeCodeType apply to this field.)
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.StartPrice 		AmountType (double) Conditionally This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For fixed-price listings: This is the fixed-price at which a buyer may purchase the item.

For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types.

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. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice.

For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead.

Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings.

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

See Listing Policies.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.StartPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SubTitle 		string Conditionally Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees).

Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle.

When you revise a item, you can add, change, or remove the subtitle.

Not applicable to Half.com.
Max length: 55.

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

See:
    Relisting Items
    (RelistItem) DeletedField
    Listing US and CA eBay Motors Items

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .OrderLineItemID 		string Always A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs.
Max length: 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .PaidTime 		dateTime Conditionally Indicates the time when the order was marked paid. This value will only be visible to the user on either side of the order. An order can be marked as paid in the following ways:
  • Automatically when a payment is made via PayPal
  • Seller marks the item as paid in My eBay or through Selling Manager Pro
  • Programmatically by the seller through the ReviseCheckoutStatus or CompleteSale calls.


Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .PaisaPayID 		string Conditionally Unique identifier for a PaisaPay transaction. Only applicable for the India site (203) if PaisaPay was the payment method used.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Platform 		TransactionPlatformCodeType Conditionally Name of the eBay co-branded site upon which the order line item (transaction) was created.

Applicable values:

•   CustomCode

(in/out) Reserved for future use.

•   eBay

(in/out) The order line item was created on the main eBay site.

•   Express

(in/out) The order line item was created on the eBay Express site.

•   Half

(in/out) The order line item was created on Half.com site.

•   Shopping

(in/out) The order line item was created on the Shopping.com site.

•   WorldOfGood

(in/out) The order line item was created on the WorldOfGood site.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .QuantityPurchased 		int Conditionally This value indicates the number of identical items purchased at the same time by the same buyer from one listing. For auction listings, this value is always 1. For fixed-price, non-variation listings, this value can be greater than 1. In either case, this field is tied to the same order line item.

Applicable to Half.com (for GetOrders).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .ShippedTime 		dateTime Conditionally Indicates the time when the item(s) associated with the order were marked as shipped. This value will only be visible to the user on either side of the order. An order can be marked as shipped in My eBay or through Selling Manager Pro, or programmatically by the seller through the CompleteSale call.

Applicable to Half.com (for GetOrders only).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Status 		TransactionStatusType Conditionally Container consisting of status details of an order line item, including payment information. Several of these fields change values during the checkout flow. See TransactionStatusType for its child elements.

For GetOrders, only the IntegratedMerchantCreditCardEnabled and PaymentMethodUsed child elements are returned. The PaymentHoldStatus container will be returned for those sellers subject to the new eBay payment process. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Status.PaymentHoldStatus 		PaymentHoldStatusCodeType Conditionally This field indicates the type and/or status of a payment hold on the item.

Applicable values:

•   CustomCode

(out) This value is reserved for internal or future use.

•   MerchantHold

(out) This value indicates a possible issue with a seller. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as PaidWithPayPal in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying.

•   NewSellerHold

(out) This value indicates that there is a "new seller hold" on the item. PayPal may hold payments to a new seller for up to 21 days. Sellers are considered "new" until they have met all three criteria below:

  • More than 90 days have passed since first successful sale
  • More than 25 domestic sales
  • More than $250.00 in total sales

•   None

(out) This value indicates that there is no payment hold on the item.

•   PaymentHold

(out) This value indicates that there is a payment hold on the item.

•   PaymentReview

(out) This value indicates a possible issue with a buyer. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as NotPaid in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying.

•   ReleaseConfirmed

(out) This value indicates that the funds are available in the seller's PayPal account.

•   Released

(out) This value indicates that a payment hold on the item has been released.

•   ReleasePending

(out) This value indicates that the process for the release of funds for the order has been initiated.




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

See Holds on PayPal Payments.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .TotalPrice 		AmountType (double) Conditionally This field indicates the total price for an order line item.

For GetMyeBaySelling, with Global Shipping Program orders, the value of this field depends on order status and the number of transactions in the order. For orders awaiting payment, the field contains the purchase price of the order line item; for paid orders, it contains the purchase price of the order line item plus the cost of domestic shipping to the international shipping provider's warehouse. With single-transaction orders, this field is returned under the OrderTransaction.Transaction container; with multiple-transaction orders, it's returned under the OrderTransaction.Order.TransactionArray.Transaction container.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .TotalPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .TotalTransactionPrice 		AmountType (double) Conditionally The price of one order line item. This amount does not take into account shipping, sales tax, and other costs related to the order line item.

If multiple units were purchased through a non-variation, fixed-price listing, this value is the total combined price for all units of the order line item. With GetMyeBaySelling, you can also get this value by multiplying SellingStatus.QuantitySold by SellingStatus.CurrentPrice.

For eBay Motors Vehicle listings, TotalTransactionPrice is the deposit amount.

Applicable to Half.com (for GetOrders).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .TotalTransactionPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .TransactionID 		string Conditionally Unique identifier for an eBay order line item. An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the TransactionID for auction listings is always 0. Along with its corresponding ItemID, a TransactionID is used and referenced during an order checkout flow and after checkout has been completed.

Applicable to Half.com (for GetOrders only).
Max length: 19 (Note: The eBay database specifies 38. Transaction IDs are usually 9 to 12 digits.).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .PaginationResult 		PaginationResultType Conditionally Specifies information about the list, including number of pages and number of entries.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .PaginationResult
  .TotalNumberOfEntries 		int Conditionally Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .PaginationResult
  .TotalNumberOfPages 		int Conditionally Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches MyeBayFavoriteSearchListType Conditionally Contains a list of the user's favorite searches. Only returned if the user has Favorite Searches. The search name, search query, and search elements, such as QueryKeywords, SortOrder, and Condition are returned.

You can paste the Search Query response, that comes back as a URL, into a browser to re-play the Favorite Search.

The search elements that are returned by this call can be used as input for the Shopping Web Service FindItemsAdvanced request.

DetailLevel: ReturnAll.
FavoriteSearches
  .FavoriteSearch 		MyeBayFavoriteSearchType Conditionally,
repeatable: [0..*]		 A favorite search the user has saved, with a name and a search query.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.BidCountMax 		int Conditionally The BidCountMax value in a My eBay Favorite Search. The BidCountMax limits the search results to items with a maximum number of bids.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.BidCountMin 		int Conditionally The BidCountMin value in a My eBay Favorite Search. The BidCountMin limits the results of a search to items with a maximum number of bids.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.CategoryID 		string Conditionally This is the unique identifier (Category ID) of the category in which the user was searching for the item for the Saved Search. Specifying a category in a query restricts the search to a specific category. If the Saved Search is not restricted to a specific category, the CategoryID field will not appear in the request.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.Condition 		ItemConditionCodeType Conditionally The Condition value in a My eBay Favorite Search. Condition limits the results to new or used items, plus items that have no condition specified.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   New

(out) The seller specified the Item Condition as New, or did not specify a condition. (Excludes items that the seller listed as Used.)

•   Used

(out) The seller specified the Item Condition as Used, or did not specify a condition. (Excludes items that the seller listed as New.)




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.Currency 		CurrencyCodeType Conditionally The appearance of a Currency value indicates that a currency filter has been specified in the Saved Search. Only listings with the specified Currency value are retrieved in the search results.

Applicable values: See Currency.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.EndTimeFrom 		dateTime Conditionally The EndTimeFrom and EndTimeFrom values indicates that a date range has been specified in the Saved Search. Only listings ending during the date range defined with the EndTimeFrom and EndTimeFrom values are retrieved in the search results.

The EndTimeFrom value indicates the beginning of the date range.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.EndTimeTo 		dateTime Conditionally The appearance of EndTimeFrom and EndTimeFrom values in the response indicates that a date range has been specified in the Saved Search. Only listings ending during the date range defined with the EndTimeFrom and EndTimeFrom values are retrieved in the search results.

The EndTimeTo value indicates the ending of the date range.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch
  .ItemsAvailableTo 		CountryCodeType Conditionally The ItemsAvailableTo value in a My eBay Favorite Search. ItemsAvailableTo limits the result set to just those items available to the specified country.

Applicable values: See ItemsAvailableTo.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.ItemsLocatedIn 		CountryCodeType Conditionally The ItemsLocatedIn value in a My eBay Favorite Search. ItemsLocatedIn limits the result set to just those items located in the specified country.

Applicable values: See ItemsLocatedIn.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.ItemSort 		SimpleItemSortCodeType Conditionally This enumeration value indicates the "Sort by" value that the user specified in the Saved Search. Some of the ways buyers can sort items include by Best Match (generally, the default), item price, item price + shipping, listing end time, and item distance (relative to the buyer's shipping address). Available sort values may vary for each search, but below is the complete set of values that may be returned in this field.

Applicable values:

•   BestMatch

(out) Sorts items by Best Match, and no sort order applies. If specified, then Best Match sort also applies to CategoryHistogram.

•   BestMatchCategoryGroup

(out) Sorts by BestMatchCategoryGroup, so results are grouped by Best Match within a category.

•   BidCount

(out) Sorts by number of bids on the item, in ascending or descending order according to the SortOrder value.

•   Country

(out) Sorts by country; no sort order can be specified.

•   CurrentBid

(out) Sorts by current bid; descending order only.

•   CustomCode

(out) This value is reserved for future or internal use.

•   Distance

(out) Sorts by distance; ascending order only.

•   EndTime

(out) Sorts by the end time of the listing, in ascending or descending order according to the SortOrder value.

•   PricePlusShipping

(out) Sorts by total cost, which is item cost plus shipping cost. If SortOrder is included and set to 'Ascending', items are sorted in the following order: Lowest total cost (for items where shipping was properly specified); then freight-shipping items (lowest to highest); and finally, items for which shipping was not specified (lowest to highest).

•   StartDate

(out) Sorts by the start time of the listing; recently-listed first.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.ItemType 		ItemTypeCodeType Conditionally Enumerated value that provides more information on the type of listing type filtering the buyer used when setting up a Saved Search in My eBay.

Applicable values:

•   AllItems

(out) When setting up filtering for the Saved Search, the buyer was looking for all items closely associated with the search term, so selected all buying formats (Auction, Buy It Now, and Classified Ads). All items are retrieved for the buyer, including auction items (with or without the Buy It Now option), fixed-price items, and classified ad listings.

•   AuctionItemsOnly

(out) When setting up filtering for the Saved Search, the buyer was only looking for auction items (with or without the Buy It Now option), so only selected the Auction checkbox in the Format dialog box. When this filter is used in a Saved Search, fixed-price items and classified ad listings are not retrieved for the buyer.

•   ClassifiedItemsOnly

(out) When setting up filtering for the Saved Search, the buyer was only looking for classified ad listings, so only selected the Classified ads checkbox in the Format dialog box. When this filter is used in a Saved Search, auction (with or without the Buy It Now option) and fixed-price items are not retrieved for the buyer.

•   CustomCode

(out) Reserved for internal or future use.

•   FixedPricedItem

(out) When setting up filtering for the Saved Search, the buyer was looking for all fixed-price items and auction items with Buy It Now available, so only selected the Buy It Now checkbox in the Format dialog box. When this filter is used in a Saved Search, auction items (without the Buy It Now option) and classified ad listings are not retrieved for the buyer.

•   StoreInventoryOnly

(out) When setting up filtering for the Saved Search, the buyer was only looking for items sold by sellers with eBay stores, so selected the Sellers with eBay stores checkbox in the Seller dialog box. When this filter is used in a Saved Search, only items for sale in an eBay store are retrieved for the buyer.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.MaxDistance 		int Conditionally The appearance of a MaxDistance value in the response indicates that a proximity (Items near me) filter has been specified in the Saved Search.

The MaxDistance value is the maximum distance (in miles) away from the buyer's postal code (specified or default) that an item may be located (based on the PostalCode value returned in the FavoriteSearch container). In a Saved Search, a buyer can supply a postal code or can base that postal code on a major city. If neither one of these methods for selecting a postal code is used, the postal code defaults to the buyer's primary shipping address. Only items located within the MaxDistance value are returned in the search results.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.PaymentMethod 		PaymentMethodSearchCodeType Conditionally The PaymentMethod value in a My eBay Favorite Search. The PaymentMethod limits the search results to items that accept a specific payment method or methods.

Applicable values:

•   CustomCode

(out)

•   PaisaPay

(out) PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203).

•   PaisaPayEscrowEMI

(out) PaisaPayEscrowEMI (Equal Monthly Installments) payment method. The PaisaPayEscrowEMI payment method is only for the India site (site ID 203).

•   PayPal

(out) PayPal payment method.

•   PayPalOrPaisaPay

(out) Either the PayPal or the PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203).




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.PostalCode 		string Conditionally The PostalCode value is either the postal code for the buyer's primary shipping address, or it is the postal code specified through the proximity (Items near me) filter of a Saved Search. In a Saved Search, a buyer can supply a postal code or can base that postal code on a major city.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch
  .PreferredLocation 		PreferredLocationCodeType Conditionally The PreferredLocation value of a My eBay Favorite Search. The PreferredLocation specifies the criteria for filtering search results by site, where site is determined by the site ID in the request.

Applicable values:

•   AvailableInCountryImplied

(out) Items available to the country implied by the site specified in the request. For the US site, this implies listings from ALL English-language countries that are available to the US.

•   BelgiumListing

(out) Items located in Belgium or listed on one of the two Belgian sites.

•   CustomCode

(out) Reserved for internal or future use.

•   ListedInCurrencyImplied

(out) Items listed in the currency implied by the site specified in the request.

•   LocatedInCountryImplied

(out) Items located in the country implied by the site specified in the request.

•   SiteImplied

(out) Items listed on the site specified in the request, regardless of listing currency.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.PriceMax 		AmountType (double) Conditionally The appearance of a PriceMax value indicates that a maximum price filter has been specified in the Saved Search. Only listings with an item price at or below the PriceMax value are retrieved in the search results.

PriceMax can be used in conjunction with PriceMin in a Saved Search to specify a price range. Only listings with item prices within this price range are retrieved in the search results.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.PriceMax
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
FavoriteSearches
  .FavoriteSearch.PriceMin 		AmountType (double) Conditionally The appearance of a PriceMin value indicates that a minimum price filter has been specified in the Saved Search. Only listings with an item price at or above the PriceMin value are retrieved in the search results.

PriceMin can be used in conjunction with PriceMax in a Saved Search to specify a price range. Only listings with item prices within this price range are retrieved in the search results.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.PriceMin
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
FavoriteSearches
  .FavoriteSearch.Quantity 		int Conditionally The Quantity value in a My eBay Favorite Search. The Quantity limits the search results to listings that offer a certain number of items matching the query. The Quantity field is used with QuantityOperator to specify that you are seeking listings with quantities greater than, equal to, or less than the value you specify in Quantity.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch
  .QuantityOperator 		QuantityOperatorCodeType Conditionally The Quantity Operator value in a My eBay Favorite Search. The Quantity Operator limits the results to listings with quantities greater than, equal to, or less than the value you specify in Quantity.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Equal

(out) Used by QuantityOperator to specify that you are seeking quantities equal to Quantity.

•   GreaterThan

(out) Used by QuantityOperator to specify that you are seeking quantities greater than Quantity.

•   GreaterThanOrEqual

(out) Used by QuantityOperator to specify that you are seeking quantities greater than or equal to Quantity.

•   LessThan

(out) Used by QuantityOperator to specify that you are seeking quantities less than Quantity.

•   LessThanOrEqual

(out) Used by QuantityOperator to specify that you are seeking quantities less than or equal to Quantity.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.QueryKeywords 		string Conditionally This string is the original search string of the buyer's Saved Search on My eBay. This is the string that the user input into the search field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.SearchFlag 		SearchFlagCodeType Conditionally,
repeatable: [0..*]		 The SearchFlag value in a My eBay Favorite Search. The SearchFlag allows you to specify whether you want to include charity listings, free-shipping listings, and listings with other features in your search.

Applicable values:

•   Charity

(out) This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer selected the eBay Giving Works option in the Saved Search.

•   CustomCode

(out) Reserved for internal or future use.

•   FreeShipping

(out) This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer selected the Free shipping option in the Saved Search. A buyer would select the Free shipping filter in a Saved Search to restrict retrieved listings to those that offer a free shipping option to that specific buyer (the availability of free shipping may be dependent on the buyer's location).

•   GermanMotorsSearchable

(out) This value is only applicable to the German site and if the user is searching for motor vehicle listings. This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer selected a filter in a Saved Search to restrict retrieved eBay Germany motor vehicle listings that are also being displayed on the mobile.de vehicle marketplace.

•   GetItFast

(out) This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer selected the Expedited shipping option in the Saved Search. A buyer would select the Expedited shipping filter in a Saved Search to restrict retrieved listings to those that offer "Get It Fast" shipping to that specific buyer (the availability of "Get It Fast" shipping may be dependent on the buyer's location).

To qualify as a "Get It Fast" listing, the seller must offer at least one expedited (overnight) shipping service to the buyer, and a handling time (also known as the DipatchTimeMax value in the Trading API) of 0 days (zero-day handling becomes available with Seller Release 13.1) or 1 day.

•   Gift

(out) This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer set a filter to only retrieve listings where the seller offers gift services to the buyer.

Gift services are not available on all sites (including the US). To see if a country supports gift services, call GeteBayDetails, using the appropriate eBay Site ID in the call header and 'ListingFeatureDetails' as a DetailName filter in the request, and then look for a ListingFeatureDetails.GiftIcon flag in the response.

•   LocalSearch

(out) This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer selected the Local pickup option in the Saved Search. A buyer would select the Local Pickup filter in a Saved Search to restrict retrieved listings to those that offer 'local pickup' as an option to buyers.

•   Lot

(out) This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer selected the Items listed as lots option in the Saved Search. A buyer would select the Items listed as lots filter in a Saved Search to restrict retrieved listings to those that are offering a "lot" of items in one listing. Specifically, a "lot" is defined as, "a group of similar or identical items that are sold together to one buyer."


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


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.SearchName 		string Conditionally The name of the buyer's Saved Search on My eBay. The name defaults to the user's original search string, or the user has the option of modifying the name of the Saved Search.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.SearchQuery 		string Conditionally This is the URL of the buyer's Saved Search on My eBay.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch
  .SellerBusinessType 		SellerBusinessCodeType Conditionally The SellerBusinessType value in a My eBay Favorite Search. The SellerBusinessType limits the search results to those of a particular seller business type such as commercial or private. SellerBusinessType is only available for sites that have business seller features enabled.

Applicable values:

•   Commercial

(out) Commercial seller account.

•   CustomCode

(out) Reserved for internal or future use.

•   Private

(out) Private seller account.

•   Undefined

(out) Type of seller account not defined.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.SellerID 		string Conditionally,
repeatable: [0..*]		 The SellerID value in a My eBay Favorite Search. The SellerID is the eBay ID of a specific seller.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch
  .SellerIDExclude 		string Conditionally,
repeatable: [0..*]		 The SellerIDExclude value in a My eBay Favorite Search. The SellerIDExclude limits the search results to exclude items sold by a specific seller or by specific sellers.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .FavoriteSearch.SortOrder 		SortOrderCodeType Conditionally The SortOrder value works in conjunction with the ItemSort value, and indicates whether Saved Search results are returned in ascending (low to high values) or descending (high to low values) order.

Applicable values:

•   Ascending

(in/out) The results will be sorted by the specified attribute in ascending (low to high) order.

•   CustomCode

(in/out) Reserved for internal or future use.

•   Descending

(in/out) The results will be sorted by the specified attribute in descending (high to low) order.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSearches
  .TotalAvailable 		int Conditionally The total number of favorite searches saved.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSellers MyeBayFavoriteSellerListType Conditionally Contains a list of the user's favorite sellers. Only returned if items exist that meet the request criteria.

DetailLevel: ReturnAll.
FavoriteSellers.FavoriteSeller MyeBayFavoriteSellerType Conditionally,
repeatable: [0..*]		 A favorite seller the user has saved, with a user ID and store name.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSellers.FavoriteSeller
  .StoreName 		string Conditionally The name of the store owned by the favorite seller, if applicable.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSellers.FavoriteSeller
  .UserID 		string Conditionally The favorite seller's eBay user ID.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FavoriteSellers.TotalAvailable int Conditionally The total number of favorite sellers saved.
Max: 100.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList PaginatedItemArrayType Conditionally Contains the items the user has bid on and lost. Only returned if items exist that meet the request criteria.

DetailLevel: ReturnAll.
LostList.ItemArray ItemArrayType Conditionally Contains a list of Item types.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.ItemArray.Item ItemType Conditionally,
repeatable: [0..*]		 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.
LostList.ItemArray.Item
  .BiddingDetails 		BiddingDetailsType Conditionally This container consists of information about the buyer's bidding history on a single auction item.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.ItemArray.Item
  .BiddingDetails
  .ConvertedMaxBid 		AmountType (double) Conditionally Converted value (from seller's currency to buyer's currency) of the amount in the MaxBid field. This field is only applicable and returned if the buyer purchased an item from an eBay site in another country. For active items, it is recommended to refresh the listing's data every 24 hours to pick up the current conversion rates.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.ItemArray.Item
  .BiddingDetails
  .ConvertedMaxBid
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
LostList.ItemArray.Item
  .BiddingDetails.MaxBid 		AmountType (double) Conditionally This value is the dollar value of the highest bid that the buyer placed on the auction item.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.ItemArray.Item
  .BiddingDetails.MaxBid
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
LostList.ItemArray.Item
  .BiddingDetails.QuantityBid 		int Conditionally This value is the total number of bids that the buyer placed on the auction item throughout the duration of the listing.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.ItemArray.Item
  .BiddingDetails.QuantityWon 		int Conditionally This field will only be returned if the buyer won the auction item, and if it is returned, its value will always be '1'.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.ItemArray.Item
  .eBayNotes 		string Conditionally Returns a note from eBay displayed below items in the user's My eBay account.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.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.
LostList.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.
LostList.ItemArray.Item
  .ListingDetails
  .ConvertedStartPrice 		AmountType (double) Conditionally Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation 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.
LostList.ItemArray.Item
  .ListingDetails
  .ConvertedStartPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
LostList.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.
LostList.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.
LostList.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.

•   Shopping

(out) Reserved for internal or future use. You can ignore Shopping.com items in your results.


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


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

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

LostList.ItemArray.Item
  .PictureDetails 		PictureDetailsType Conditionally Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture.


Not applicable to Half.com.

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

See Introduction to Pictures in Item Listings.
LostList.ItemArray.Item
  .PictureDetails.GalleryURL 		anyURI Conditionally Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing.

Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide.

(See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings.

Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name.
Max length: 1024.

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

See:
    Introduction to Pictures in Item Listings
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.
    (ReviseItem) DeletedField

LostList.ItemArray.Item
  .PrivateNotes 		string Conditionally A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note.

Not supported as input in ReviseItem. Use SetUserNotes instead.

For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)
LostList.ItemArray.Item.Seller UserType Conditionally Container for information about this listing's seller.

Not applicable to Half.com.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.ItemArray.Item.Seller
  .FeedbackRatingStar 		FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.ItemArray.Item.Seller
  .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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
LostList.ItemArray.Item.Seller
  .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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
LostList.ItemArray.Item
  .SellingStatus 		SellingStatusType Conditionally 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.
LostList.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.
LostList.ItemArray.Item
  .SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation 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.
LostList.ItemArray.Item
  .SellingStatus
  .ConvertedCurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
LostList.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.
LostList.ItemArray.Item
  .SellingStatus.CurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
LostList.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. Also returned if DetailLevel is not provided on input.
LostList.ItemArray.Item
  .SellingStatus.HighBidder
  .FeedbackRatingStar 		FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
LostList.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
LostList.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

LostList.ItemArray.Item
  .StartPrice 		AmountType (double) Conditionally This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For fixed-price listings: This is the fixed-price at which a buyer may purchase the item.

For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types.

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. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice.

For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead.

Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings.

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

See Listing Policies.
LostList.ItemArray.Item
  .StartPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
LostList.ItemArray.Item
  .SubTitle 		string Conditionally Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees).

Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle.

When you revise a item, you can add, change, or remove the subtitle.

Not applicable to Half.com.
Max length: 55.

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

See:
    Relisting Items
    (RelistItem) DeletedField
    Listing US and CA eBay Motors Items

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

LostList.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.
LostList.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.
LostList.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.
LostList.PaginationResult PaginationResultType Conditionally Provides information about the list, including number of pages and number of entries.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.PaginationResult
  .TotalNumberOfEntries 		int Conditionally Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.PaginationResult
  .TotalNumberOfPages 		int Conditionally Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
SecondChanceOffer ItemType Conditionally,
repeatable: [0..*]		 Contains the list of second chance offers the user has received. Only returned if items exist that meet the request criteria.

DetailLevel: ReturnAll.
SecondChanceOffer.eBayNotes string Conditionally Returns a note from eBay displayed below items in the user's My eBay account.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
SecondChanceOffer.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.
SecondChanceOffer
  .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.
SecondChanceOffer
  .ListingDetails
  .ConvertedBuyItNowPrice 		AmountType (double) Conditionally Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
SecondChanceOffer
  .ListingDetails
  .ConvertedBuyItNowPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
SecondChanceOffer
  .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.
SecondChanceOffer
  .PictureDetails 		PictureDetailsType Conditionally Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture.


Not applicable to Half.com.

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

See Introduction to Pictures in Item Listings.
SecondChanceOffer
  .PictureDetails.GalleryURL 		anyURI Conditionally Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing.

Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide.

(See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings.

Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name.
Max length: 1024.

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

See:
    Introduction to Pictures in Item Listings
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.
    (ReviseItem) DeletedField

SecondChanceOffer.PrivateNotes string Conditionally A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note.

Not supported as input in ReviseItem. Use SetUserNotes instead.

For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)
SecondChanceOffer.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

SecondChanceOffer.SubTitle string Conditionally Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees).

Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle.

When you revise a item, you can add, change, or remove the subtitle.

Not applicable to Half.com.
Max length: 55.

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

See:
    Relisting Items
    (RelistItem) DeletedField
    Listing US and CA eBay Motors Items

SecondChanceOffer.TimeLeft duration Conditionally Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
SecondChanceOffer.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.
UserDefinedList UserDefinedListType Conditionally,
repeatable: [0..*]		 Contains the items, searches, or sellers that the user has saved to this list using the "Add to list" feature. The name of the list is given by the "Name" element. Returned only if UserDefineLists is specified in the request.
UserDefinedList
  .FavoriteSearches 		MyeBayFavoriteSearchListType Conditionally An array of Favorite Searches that the user has added to the user-defined list.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch 		MyeBayFavoriteSearchType Conditionally,
repeatable: [0..*]		 A favorite search the user has saved, with a name and a search query.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.BidCountMax 		int Conditionally The BidCountMax value in a My eBay Favorite Search. The BidCountMax limits the search results to items with a maximum number of bids.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.BidCountMin 		int Conditionally The BidCountMin value in a My eBay Favorite Search. The BidCountMin limits the results of a search to items with a maximum number of bids.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.CategoryID 		string Conditionally This is the unique identifier (Category ID) of the category in which the user was searching for the item for the Saved Search. Specifying a category in a query restricts the search to a specific category. If the Saved Search is not restricted to a specific category, the CategoryID field will not appear in the request.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.Condition 		ItemConditionCodeType Conditionally The Condition value in a My eBay Favorite Search. Condition limits the results to new or used items, plus items that have no condition specified.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   New

(out) The seller specified the Item Condition as New, or did not specify a condition. (Excludes items that the seller listed as Used.)

•   Used

(out) The seller specified the Item Condition as Used, or did not specify a condition. (Excludes items that the seller listed as New.)




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.Currency 		CurrencyCodeType Conditionally The appearance of a Currency value indicates that a currency filter has been specified in the Saved Search. Only listings with the specified Currency value are retrieved in the search results.

Applicable values: See Currency.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.EndTimeFrom 		dateTime Conditionally The EndTimeFrom and EndTimeFrom values indicates that a date range has been specified in the Saved Search. Only listings ending during the date range defined with the EndTimeFrom and EndTimeFrom values are retrieved in the search results.

The EndTimeFrom value indicates the beginning of the date range.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.EndTimeTo 		dateTime Conditionally The appearance of EndTimeFrom and EndTimeFrom values in the response indicates that a date range has been specified in the Saved Search. Only listings ending during the date range defined with the EndTimeFrom and EndTimeFrom values are retrieved in the search results.

The EndTimeTo value indicates the ending of the date range.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch
  .ItemsAvailableTo 		CountryCodeType Conditionally The ItemsAvailableTo value in a My eBay Favorite Search. ItemsAvailableTo limits the result set to just those items available to the specified country.

Applicable values: See ItemsAvailableTo.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.ItemsLocatedIn 		CountryCodeType Conditionally The ItemsLocatedIn value in a My eBay Favorite Search. ItemsLocatedIn limits the result set to just those items located in the specified country.

Applicable values: See ItemsLocatedIn.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.ItemSort 		SimpleItemSortCodeType Conditionally This enumeration value indicates the "Sort by" value that the user specified in the Saved Search. Some of the ways buyers can sort items include by Best Match (generally, the default), item price, item price + shipping, listing end time, and item distance (relative to the buyer's shipping address). Available sort values may vary for each search, but below is the complete set of values that may be returned in this field.

Applicable values:

•   BestMatch

(out) Sorts items by Best Match, and no sort order applies. If specified, then Best Match sort also applies to CategoryHistogram.

•   BestMatchCategoryGroup

(out) Sorts by BestMatchCategoryGroup, so results are grouped by Best Match within a category.

•   BidCount

(out) Sorts by number of bids on the item, in ascending or descending order according to the SortOrder value.

•   Country

(out) Sorts by country; no sort order can be specified.

•   CurrentBid

(out) Sorts by current bid; descending order only.

•   CustomCode

(out) This value is reserved for future or internal use.

•   Distance

(out) Sorts by distance; ascending order only.

•   EndTime

(out) Sorts by the end time of the listing, in ascending or descending order according to the SortOrder value.

•   PricePlusShipping

(out) Sorts by total cost, which is item cost plus shipping cost. If SortOrder is included and set to 'Ascending', items are sorted in the following order: Lowest total cost (for items where shipping was properly specified); then freight-shipping items (lowest to highest); and finally, items for which shipping was not specified (lowest to highest).

•   StartDate

(out) Sorts by the start time of the listing; recently-listed first.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.ItemType 		ItemTypeCodeType Conditionally Enumerated value that provides more information on the type of listing type filtering the buyer used when setting up a Saved Search in My eBay.

Applicable values:

•   AllItems

(out) When setting up filtering for the Saved Search, the buyer was looking for all items closely associated with the search term, so selected all buying formats (Auction, Buy It Now, and Classified Ads). All items are retrieved for the buyer, including auction items (with or without the Buy It Now option), fixed-price items, and classified ad listings.

•   AuctionItemsOnly

(out) When setting up filtering for the Saved Search, the buyer was only looking for auction items (with or without the Buy It Now option), so only selected the Auction checkbox in the Format dialog box. When this filter is used in a Saved Search, fixed-price items and classified ad listings are not retrieved for the buyer.

•   ClassifiedItemsOnly

(out) When setting up filtering for the Saved Search, the buyer was only looking for classified ad listings, so only selected the Classified ads checkbox in the Format dialog box. When this filter is used in a Saved Search, auction (with or without the Buy It Now option) and fixed-price items are not retrieved for the buyer.

•   CustomCode

(out) Reserved for internal or future use.

•   FixedPricedItem

(out) When setting up filtering for the Saved Search, the buyer was looking for all fixed-price items and auction items with Buy It Now available, so only selected the Buy It Now checkbox in the Format dialog box. When this filter is used in a Saved Search, auction items (without the Buy It Now option) and classified ad listings are not retrieved for the buyer.

•   StoreInventoryOnly

(out) When setting up filtering for the Saved Search, the buyer was only looking for items sold by sellers with eBay stores, so selected the Sellers with eBay stores checkbox in the Seller dialog box. When this filter is used in a Saved Search, only items for sale in an eBay store are retrieved for the buyer.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.MaxDistance 		int Conditionally The appearance of a MaxDistance value in the response indicates that a proximity (Items near me) filter has been specified in the Saved Search.

The MaxDistance value is the maximum distance (in miles) away from the buyer's postal code (specified or default) that an item may be located (based on the PostalCode value returned in the FavoriteSearch container). In a Saved Search, a buyer can supply a postal code or can base that postal code on a major city. If neither one of these methods for selecting a postal code is used, the postal code defaults to the buyer's primary shipping address. Only items located within the MaxDistance value are returned in the search results.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.PaymentMethod 		PaymentMethodSearchCodeType Conditionally The PaymentMethod value in a My eBay Favorite Search. The PaymentMethod limits the search results to items that accept a specific payment method or methods.

Applicable values:

•   CustomCode

(out)

•   PaisaPay

(out) PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203).

•   PaisaPayEscrowEMI

(out) PaisaPayEscrowEMI (Equal Monthly Installments) payment method. The PaisaPayEscrowEMI payment method is only for the India site (site ID 203).

•   PayPal

(out) PayPal payment method.

•   PayPalOrPaisaPay

(out) Either the PayPal or the PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203).




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.PostalCode 		string Conditionally The PostalCode value is either the postal code for the buyer's primary shipping address, or it is the postal code specified through the proximity (Items near me) filter of a Saved Search. In a Saved Search, a buyer can supply a postal code or can base that postal code on a major city.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch
  .PreferredLocation 		PreferredLocationCodeType Conditionally The PreferredLocation value of a My eBay Favorite Search. The PreferredLocation specifies the criteria for filtering search results by site, where site is determined by the site ID in the request.

Applicable values:

•   AvailableInCountryImplied

(out) Items available to the country implied by the site specified in the request. For the US site, this implies listings from ALL English-language countries that are available to the US.

•   BelgiumListing

(out) Items located in Belgium or listed on one of the two Belgian sites.

•   CustomCode

(out) Reserved for internal or future use.

•   ListedInCurrencyImplied

(out) Items listed in the currency implied by the site specified in the request.

•   LocatedInCountryImplied

(out) Items located in the country implied by the site specified in the request.

•   SiteImplied

(out) Items listed on the site specified in the request, regardless of listing currency.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.PriceMax 		AmountType (double) Conditionally The appearance of a PriceMax value indicates that a maximum price filter has been specified in the Saved Search. Only listings with an item price at or below the PriceMax value are retrieved in the search results.

PriceMax can be used in conjunction with PriceMin in a Saved Search to specify a price range. Only listings with item prices within this price range are retrieved in the search results.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.PriceMax
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.PriceMin 		AmountType (double) Conditionally The appearance of a PriceMin value indicates that a minimum price filter has been specified in the Saved Search. Only listings with an item price at or above the PriceMin value are retrieved in the search results.

PriceMin can be used in conjunction with PriceMax in a Saved Search to specify a price range. Only listings with item prices within this price range are retrieved in the search results.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.PriceMin
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.Quantity 		int Conditionally The Quantity value in a My eBay Favorite Search. The Quantity limits the search results to listings that offer a certain number of items matching the query. The Quantity field is used with QuantityOperator to specify that you are seeking listings with quantities greater than, equal to, or less than the value you specify in Quantity.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch
  .QuantityOperator 		QuantityOperatorCodeType Conditionally The Quantity Operator value in a My eBay Favorite Search. The Quantity Operator limits the results to listings with quantities greater than, equal to, or less than the value you specify in Quantity.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Equal

(out) Used by QuantityOperator to specify that you are seeking quantities equal to Quantity.

•   GreaterThan

(out) Used by QuantityOperator to specify that you are seeking quantities greater than Quantity.

•   GreaterThanOrEqual

(out) Used by QuantityOperator to specify that you are seeking quantities greater than or equal to Quantity.

•   LessThan

(out) Used by QuantityOperator to specify that you are seeking quantities less than Quantity.

•   LessThanOrEqual

(out) Used by QuantityOperator to specify that you are seeking quantities less than or equal to Quantity.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.QueryKeywords 		string Conditionally This string is the original search string of the buyer's Saved Search on My eBay. This is the string that the user input into the search field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.SearchFlag 		SearchFlagCodeType Conditionally,
repeatable: [0..*]		 The SearchFlag value in a My eBay Favorite Search. The SearchFlag allows you to specify whether you want to include charity listings, free-shipping listings, and listings with other features in your search.

Applicable values:

•   Charity

(out) This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer selected the eBay Giving Works option in the Saved Search.

•   CustomCode

(out) Reserved for internal or future use.

•   FreeShipping

(out) This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer selected the Free shipping option in the Saved Search. A buyer would select the Free shipping filter in a Saved Search to restrict retrieved listings to those that offer a free shipping option to that specific buyer (the availability of free shipping may be dependent on the buyer's location).

•   GermanMotorsSearchable

(out) This value is only applicable to the German site and if the user is searching for motor vehicle listings. This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer selected a filter in a Saved Search to restrict retrieved eBay Germany motor vehicle listings that are also being displayed on the mobile.de vehicle marketplace.

•   GetItFast

(out) This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer selected the Expedited shipping option in the Saved Search. A buyer would select the Expedited shipping filter in a Saved Search to restrict retrieved listings to those that offer "Get It Fast" shipping to that specific buyer (the availability of "Get It Fast" shipping may be dependent on the buyer's location).

To qualify as a "Get It Fast" listing, the seller must offer at least one expedited (overnight) shipping service to the buyer, and a handling time (also known as the DipatchTimeMax value in the Trading API) of 0 days (zero-day handling becomes available with Seller Release 13.1) or 1 day.

•   Gift

(out) This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer set a filter to only retrieve listings where the seller offers gift services to the buyer.

Gift services are not available on all sites (including the US). To see if a country supports gift services, call GeteBayDetails, using the appropriate eBay Site ID in the call header and 'ListingFeatureDetails' as a DetailName filter in the request, and then look for a ListingFeatureDetails.GiftIcon flag in the response.

•   LocalSearch

(out) This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer selected the Local pickup option in the Saved Search. A buyer would select the Local Pickup filter in a Saved Search to restrict retrieved listings to those that offer 'local pickup' as an option to buyers.

•   Lot

(out) This value being returned in the FavoriteSearch.SearchFlag field indicates that the buyer selected the Items listed as lots option in the Saved Search. A buyer would select the Items listed as lots filter in a Saved Search to restrict retrieved listings to those that are offering a "lot" of items in one listing. Specifically, a "lot" is defined as, "a group of similar or identical items that are sold together to one buyer."


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


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.SearchName 		string Conditionally The name of the buyer's Saved Search on My eBay. The name defaults to the user's original search string, or the user has the option of modifying the name of the Saved Search.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.SearchQuery 		string Conditionally This is the URL of the buyer's Saved Search on My eBay.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch
  .SellerBusinessType 		SellerBusinessCodeType Conditionally The SellerBusinessType value in a My eBay Favorite Search. The SellerBusinessType limits the search results to those of a particular seller business type such as commercial or private. SellerBusinessType is only available for sites that have business seller features enabled.

Applicable values:

•   Commercial

(out) Commercial seller account.

•   CustomCode

(out) Reserved for internal or future use.

•   Private

(out) Private seller account.

•   Undefined

(out) Type of seller account not defined.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.SellerID 		string Conditionally,
repeatable: [0..*]		 The SellerID value in a My eBay Favorite Search. The SellerID is the eBay ID of a specific seller.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch
  .SellerIDExclude 		string Conditionally,
repeatable: [0..*]		 The SellerIDExclude value in a My eBay Favorite Search. The SellerIDExclude limits the search results to exclude items sold by a specific seller or by specific sellers.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .FavoriteSearch.SortOrder 		SortOrderCodeType Conditionally The SortOrder value works in conjunction with the ItemSort value, and indicates whether Saved Search results are returned in ascending (low to high values) or descending (high to low values) order.

Applicable values:

•   Ascending

(in/out) The results will be sorted by the specified attribute in ascending (low to high) order.

•   CustomCode

(in/out) Reserved for internal or future use.

•   Descending

(in/out) The results will be sorted by the specified attribute in descending (high to low) order.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSearches
  .TotalAvailable 		int Conditionally The total number of favorite searches saved.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSellerCount 		int Conditionally The value in this field indicates the total number of favorite sellers in the user-defined list. The number of FavoriteSeller nodes returned in the response should match this value.
UserDefinedList
  .FavoriteSellers 		MyeBayFavoriteSellerListType Conditionally An array of Favorite Sellers that the user has added to the user-defined list.
UserDefinedList
  .FavoriteSellers
  .FavoriteSeller 		MyeBayFavoriteSellerType Conditionally,
repeatable: [0..*]		 A favorite seller the user has saved, with a user ID and store name.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSellers
  .FavoriteSeller.StoreName 		string Conditionally The name of the store owned by the favorite seller, if applicable.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSellers
  .FavoriteSeller.UserID 		string Conditionally The favorite seller's eBay user ID.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList
  .FavoriteSellers
  .TotalAvailable 		int Conditionally The total number of favorite sellers saved.
Max: 100.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList.ItemArray ItemArrayType Conditionally An array of Items that the user has added to the user-defined list.
UserDefinedList.ItemArray.Item ItemType Conditionally,
repeatable: [0..*]		 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.
UserDefinedList.ItemArray.Item
  .eBayNotes 		string Conditionally Returns a note from eBay displayed below items in the user's My eBay account.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList.ItemArray.Item
  .PrivateNotes 		string Conditionally A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note.

Not supported as input in ReviseItem. Use SetUserNotes instead.

For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)
UserDefinedList.ItemArray.Item
  .ProductListingDetails 		ProductListingDetailsType Conditionally Specifies stock product information to include in a listing. Only applicable when listing items with product details. See the eBay Trading API Guide for information on listing with product details.

As ProductID and ProductReferenceID are defined by eBay, they provide the most reliable means to identify a product. If you use one of the other industry identifiers (e.g., UPC), eBay attempts to find a matching product on your behalf and use it in the listing. If no match is found, you can try using FindProducts in the Shopping API to determine a ProductReferenceID.

When you specify ProductListingDetails, you must specify at least one of the available identifiers (e.g., UPC). If you specify more than one (such as UPC and BrandMPN), eBay uses the first one that matches a product in eBay's catalog system. (This may be useful if you aren't sure which identifier is more likely to result in a match.)

When you specify TicketListingDetails, you must specify the Event Tickets category as the primary category. For other product identifiers: If you list in two categories and the primary and secondary categories are both catalog-enabled, this product identifier should correspond to the primary category (not the secondary category). If only one category is catalog-enabled, the product identifier should correspond to the catalog-enabled category.

Note: As a general rule, the primary category is required. However, if you have trouble finding a catalog-enabled category, you may be able to omit the primary category (except for event tickets). If you do, eBay will attempt to determine an appropriate category based on the product ID (if we find a matching product). When you specify a category that corresponds to the product, your category is used. If we don't find a match in our catalogs, we will list the item in the primary category you specified, without product details. We will not pre-fill the listing's item specifics in this case, and the identifier won't be surfaced in View Item or returned in GetItem. However, it will still be indexed for search on eBay, and it will be searchable by more third-party natural search engines. As this can help buyers find your listing more easily, we strongly recommend that you always use ProductListingDetails to pass in these values. (This product indexing behavior is only available if you use UPC, ISBN, EAN, or GTIN in ProductListingDetails. It is not available if you use ExternalProductID, and it may not be available if you exclusively use Item Specifics.)

Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem request, but not both. (ExternalProductID is no longer recommended.)

For ReviseItem and RelistItem only: If a listing includes product details and you change a category, the rules for continuing to include product details depend on whether or not the new category is mapped to a characteristic set associated with the same product ID. When you revise a listing, if it has bids or it ends within 12 hours, you cannot change the product ID and you cannot remove existing product data. However, you can change or add preferences such as IncludeStockPhotoURL, UseStockPhotoURLAsGallery, and IncludePrefilledItemInformation. To delete all catalog data when you revise or relist an item, specify Item.ProductListingDetails in DeletedField and don't pass ProductListingDetails in the request.

For GetMyeBayBuying only: When products have been added to a buyer's Wish List, the product information is returned in ItemArray.Item.ProductListingDetails within the UserDefinedList node. Products can be added to a buyer's Wish List only. Does not apply to any other user-defined list. The ProductListingDetails node is not included for items in the Wish List.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList.ItemArray.Item
  .ProductListingDetails
  .ProductDetailsURL 		anyURI Conditionally Fully qualified URL for eBay's product details page, which contains optional information about the product (such as a movie's description or film credits). This information is hosted through the eBay Web site and it cannot be edited. Portions of the content are protected by copyright. Applications can include this URL as a link so that end users can view additional descriptive details about the product.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList.ItemArray.Item
  .ProductListingDetails
  .ProductID 		string Conditionally eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter product ID (ePID) value that is displayed on the eBay Web site, see ProductReferenceID instead.)

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).

In item-listing requests, if you pass in an old product ID, eBay lists the item with the latest version of the product and the latest product ID, and the call returns a warning indicating that the data has changed.

Some sites (such as eBay US, Germany, Austria, and Switzerland) are updating, replacing, deleting, or merging some products (as a result of migrating from one catalog data provider to another). If you specify one of these products in a request, the call may return the product with a warning, or it may fail with an error if the product has been deleted.
Max length: 4000.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList.ItemArray.Item
  .ProductListingDetails
  .StockPhotoURL 		anyURI Conditionally Fully qualified URL for a standard image (if any) that is associated with the product. A seller includes the stock photo in the listing by setting IncludeStockPhotoURL.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
UserDefinedList.ItemCount int Conditionally The value in this field indicates the total number of items in the user-defined list. The number of Item nodes in the ItemArray should match this value.
UserDefinedList.Name string Conditionally The user's chosen name for this list.
WatchList PaginatedItemArrayType Conditionally Contains the items the user is watching. Only returned if items exist that meet the request criteria.

DetailLevel: ReturnAll.
WatchList.ItemArray ItemArrayType Conditionally Contains a list of Item types.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
WatchList.ItemArray.Item ItemType Conditionally,
repeatable: [0..*]		 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.
WatchList.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. Also returned if DetailLevel is not provided on input.

See:
    Listing Policies
    Revising Items

WatchList.ItemArray.Item
  .BuyItNowPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
WatchList.ItemArray.Item
  .eBayNotes 		string Conditionally Returns a note from eBay displayed below items in the user's My eBay account.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
WatchList.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.
WatchList.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.
WatchList.ItemArray.Item
  .ListingDetails
  .ConvertedBuyItNowPrice 		AmountType (double) Conditionally Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
WatchList.ItemArray.Item
  .ListingDetails
  .ConvertedBuyItNowPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
WatchList.ItemArray.Item
  .ListingDetails
  .ConvertedStartPrice 		AmountType (double) Conditionally Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation 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.
WatchList.ItemArray.Item
  .ListingDetails
  .ConvertedStartPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
WatchList.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.
WatchList.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.
WatchList.ItemArray.Item
  .ListingDetails.ViewItemURL 		anyURI Conditionally The URL of the Web page where a user can view the listing. On the US site, this is called the "View Item" page. If you enabled affiliate tracking in a search-related call (for example, if you used the AffiliateTrackingDetails container in an applicable call), ViewItemURL contains a string that includes affiliate tracking information (see the eBay Partner Network).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
WatchList.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.

•   Shopping

(out) Reserved for internal or future use. You can ignore Shopping.com items in your results.


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


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

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

WatchList.ItemArray.Item
  .PictureDetails 		PictureDetailsType Conditionally Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture.


Not applicable to Half.com.

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

See Introduction to Pictures in Item Listings.
WatchList.ItemArray.Item
  .PictureDetails.GalleryURL 		anyURI Conditionally Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing.

Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide.

(See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings.

Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name.
Max length: 1024.

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

See:
    Introduction to Pictures in Item Listings
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.
    (ReviseItem) DeletedField

WatchList.ItemArray.Item
  .PrivateNotes 		string Conditionally A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note.

Not supported as input in ReviseItem. Use SetUserNotes instead.

For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)
WatchList.ItemArray.Item
  .QuantityAvailable 		int Conditionally Specifies how many of a certain item are available.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
WatchList.ItemArray.Item
  .Seller 		UserType Conditionally Container for information about this listing's seller.

Not applicable to Half.com.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
WatchList.ItemArray.Item
  .Seller.FeedbackRatingStar 		FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
WatchList.ItemArray.Item
  .Seller.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
WatchList.ItemArray.Item
  .Seller.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
WatchList.ItemArray.Item
  .SellingStatus 		SellingStatusType Conditionally 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.
WatchList.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.
WatchList.ItemArray.Item
  .SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation 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.
WatchList.ItemArray.Item
  .SellingStatus
  .ConvertedCurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
WatchList.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.
WatchList.ItemArray.Item
  .SellingStatus.CurrentPrice
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
WatchList.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. Also returned if DetailLevel is not provided on input.
WatchList.ItemArray.Item
  .SellingStatus.HighBidder
  .FeedbackRatingStar 		FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
WatchList.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. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.
WatchList.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 indicat