eBay Trading APIVersion 1039

GetMyeBayBuying

Use this call to retrieve 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.

Usage 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 Testing in 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:



Input

See also Samples.

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 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>
    <IncludeListContents> boolean </IncludeListContents>
    <MaxResults> int </MaxResults>
    <Sort> SortOrderCodeType </Sort>
    <UserDefinedListName> string </UserDefinedListName>
  </FavoriteSearches>
  <FavoriteSellers> MyeBaySelectionType
    <Include> boolean </Include>
    <IncludeFavoriteSellerCount> boolean </IncludeFavoriteSellerCount>
    <IncludeItemCount> boolean </IncludeItemCount>
    <IncludeListContents> boolean </IncludeListContents>
    <MaxResults> int </MaxResults>
    <Sort> SortOrderCodeType </Sort>
    <UserDefinedListName> string </UserDefinedListName>
  </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>
    <IncludeListContents> boolean </IncludeListContents>
    <MaxResults> int </MaxResults>
    <Sort> SortOrderCodeType </Sort>
    <UserDefinedListName> string </UserDefinedListName>
  </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 Include this container and set the BestOfferList.Include field to true to return the list of items on which the eBay user has made a Best Offer.

The user also has the option of using pagination and sorting for the list of items that will be returned.
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 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) This enumeration value is only applicable to the GetMyeBaySelling call. This value is used in the ActiveList.ListingType field if the seller only wants to retrieve active listings that are in the auction format.
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 eBay Features Guide for more information.

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.

The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.
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 the 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 Include this container and set the BidList.Include field to true to return the list of auction items on which the eBay user has bid.

The user also has the option of using pagination and sorting for the list of auction items that will be returned.
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.

The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.
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 the 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 Include this container and set the BuyingSummary.Include field to true to return the BuyingSummary container in the response. The BuyingSummary container consists of buying/bidding activity counts and values.
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 Include this container and set the DeletedFromLostList.Include field to true to return the list of auction items on which the eBay user has bid on and lost, and has deleted from their My eBay page.

The user also has the option of using pagination and sorting for the list of auction items that will be returned.
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.

The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.
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 the 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 Include this container and set the DeletedFromWonList.Include field to true to return the list of auction items on which the eBay user has bid on and won, but has deleted from their My eBay page.

The user also has the option of using pagination and sorting for the list of auction items that will be returned.
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.

The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.
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 the 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 Include this container and set the FavoriteSearches.Include field to true to return the list of the eBay user's saved searches.
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
  .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.
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 key 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 key in descending (high to low) order.
FavoriteSearches
  .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.
FavoriteSellers MyeBaySelectionType Optional Include this container and set the FavoriteSellers.Include field to true to return the list of the eBay user's saved sellers.
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
  .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.
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 key 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 key in descending (high to low) order.
FavoriteSellers
  .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.
HideVariations boolean Optional If this field is included and set to true, the Variations node (and all variation data) is omitted for all multiple-variation listings in the response. If this field is omitted or set to false, the Variations node is returned for all multiple-variation listings in the response.

Default: false.
LostList ItemListCustomizationType Optional Include this container and set the LostList.Include field to true to return the list of auction items on which the eBay user has bid on and lost.

The user also has the option of using pagination and sorting for the list of auction items that will be returned.
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.

The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.
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 the 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 Include this container and set the SecondChanceOffer.Include field to true to return any Second Chance Offers that the eBay user has received.
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
  .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.
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 key 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 key in descending (high to low) order.
SecondChanceOffer
  .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.
UserDefinedLists MyeBaySelectionType Optional Include this container and set the UserDefinedLists.Include field to true to return one or more user-defined lists. User-defined lists are lists created by the user in My eBay and consists of a combination of items, saved sellers, and/or saved searches.
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 key 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 key 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 Include this container and set the WatchList.Include field to true to return the list of items on the eBay user's Watch List.

The user also has the option of using pagination and sorting for the list of watched items that will be returned.
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.

The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.
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 the 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 Include this container and set the WonList.Include field to true to return the list of auction items on which the eBay user has bid on and won.

The user also has the option of using pagination and sorting for the list of auction items that will be returned.
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.

The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.
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 the 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 and 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.

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 GranularityLevel instead, or use GetSellerEvents. If you do use 'ReturnAll' with GetSellerList, use a small Pagination.EntriesPerPage value and a narrow EndTimeFrom/EndTimeTo date 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 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
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States

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 a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the OutputSelector field, the output data will only include the fields you specified in the request. For example, if you are using GetItem and you only want to retrieve the URL of the View Item page (emitted in ViewItemURL field) and the item's Buy It Now price (emitted in BuyItNowPrice field), you would include two separate OutputSelector fields and set the value for each one as ViewItemURL and BuyItNowPrice as in the following example:

 ...
<OutputSelector>ViewItemURL</OutputSelector>
<OutputSelector>BuyItNowPrice</OutputSelector>

...

See Selecting Fields to Retrieve.

Version string Conditional The version number of the API code that you are programming against (e.g., 859). 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 performed in the Production environment.

Applicable values:

High
(in) The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.
Low
(in) The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level.



Output

See also Samples.

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 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 </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
          <InternationalShippingServiceOption> InternationalShippingServiceOptionsType </InternationalShippingServiceOption>
          <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
          <ShippingServiceOptions> ShippingServiceOptionsType
            <ExpeditedService> boolean </ExpeditedService>
            <FreeShipping> boolean </FreeShipping>
            <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
            <LocalPickup> boolean </LocalPickup>
            <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
            <ShippingService> token </ShippingService>
            <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
            <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
            <ShippingServicePriority> int </ShippingServicePriority>
            <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
            <ShippingTimeMax> int </ShippingTimeMax>
            <ShippingTimeMin> int </ShippingTimeMin>
          </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>
          <Winning> boolean </Winning>
        </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 </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
          <InternationalShippingServiceOption> InternationalShippingServiceOptionsType </InternationalShippingServiceOption>
          <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
          <ShippingServiceOptions> ShippingServiceOptionsType
            <ExpeditedService> boolean </ExpeditedService>
            <FreeShipping> boolean </FreeShipping>
            <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
            <LocalPickup> boolean </LocalPickup>
            <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
            <ShippingService> token </ShippingService>
            <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
            <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
            <ShippingServicePriority> int </ShippingServicePriority>
            <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
            <ShippingTimeMax> int </ShippingTimeMax>
            <ShippingTimeMin> int </ShippingTimeMin>
          </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 </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
          <BuyerPackageEnclosures> BuyerPackageEnclosuresType
            <BuyerPackageEnclosure type="PaymentInstructionCodeType"> BuyerPackageEnclosureType (string) </BuyerPackageEnclosure>
            <!-- ... more BuyerPackageEnclosure values allowed here ... -->
          </BuyerPackageEnclosures>
          <OrderID> OrderIDType (string) </OrderID>
          <PickupDetails> PickupDetailsType
            <PickupOptions> PickupOptionsType
              <PickupMethod> token </PickupMethod>
              <PickupPriority> int </PickupPriority>
            </PickupOptions>
            <!-- ... more PickupOptions nodes allowed here ... -->
          </PickupDetails>
          <PickupMethodSelected> PickupMethodSelectedType
            <MerchantPickupCode> string </MerchantPickupCode>
            <PickupLocationUUID> string </PickupLocationUUID>
            <PickupMethod> token </PickupMethod>
            <PickupStatus> PickupStatusCodeType </PickupStatus>
            <PickupStoreID> string </PickupStoreID>
          </PickupMethodSelected>
          <ShippingDetails> ShippingDetailsType
            <InternationalShippingServiceOption> InternationalShippingServiceOptionsType </InternationalShippingServiceOption>
            <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
            <ShippingServiceOptions> ShippingServiceOptionsType
              <ExpeditedService> boolean </ExpeditedService>
              <FreeShipping> boolean </FreeShipping>
              <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
              <LocalPickup> boolean </LocalPickup>
              <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
              <ShippingService> token </ShippingService>
              <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
              <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
              <ShippingServicePriority> int </ShippingServicePriority>
              <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
              <ShippingTimeMax> int </ShippingTimeMax>
              <ShippingTimeMin> int </ShippingTimeMin>
            </ShippingServiceOptions>
            <!-- ... more ShippingServiceOptions nodes allowed here ... -->
            <ShippingType> ShippingTypeCodeType </ShippingType>
          </ShippingDetails>
          <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 </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
                  <InternationalShippingServiceOption> InternationalShippingServiceOptionsType </InternationalShippingServiceOption>
                  <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
                  <ShippingServiceOptions> ShippingServiceOptionsType
                    <ExpeditedService> boolean </ExpeditedService>
                    <FreeShipping> boolean </FreeShipping>
                    <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
                    <LocalPickup> boolean </LocalPickup>
                    <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
                    <ShippingService> token </ShippingService>
                    <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
                    <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
                    <ShippingServicePriority> int </ShippingServicePriority>
                    <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
                    <ShippingTimeMax> int </ShippingTimeMax>
                    <ShippingTimeMin> int </ShippingTimeMin>
                  </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>
              <PickupDetails> PickupDetailsType
                <PickupOptions> PickupOptionsType
                  <PickupMethod> token </PickupMethod>
                  <PickupPriority> int </PickupPriority>
                </PickupOptions>
                <!-- ... more PickupOptions nodes allowed here ... -->
              </PickupDetails>
              <PickupMethodSelected> PickupMethodSelectedType
                <MerchantPickupCode> string </MerchantPickupCode>
                <PickupLocationUUID> string </PickupLocationUUID>
                <PickupMethod> token </PickupMethod>
                <PickupStatus> PickupStatusCodeType </PickupStatus>
                <PickupStoreID> string </PickupStoreID>
              </PickupMethodSelected>
              <Platform> TransactionPlatformCodeType </Platform>
              <QuantityPurchased> int </QuantityPurchased>
              <ShippedTime> dateTime </ShippedTime>
              <Status> TransactionStatusType
                <CancelStatus> CancelStatusCodeType </CancelStatus>
                <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 </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
              <InternationalShippingServiceOption> InternationalShippingServiceOptionsType </InternationalShippingServiceOption>
              <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
              <ShippingServiceOptions> ShippingServiceOptionsType
                <ExpeditedService> boolean </ExpeditedService>
                <FreeShipping> boolean </FreeShipping>
                <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
                <LocalPickup> boolean </LocalPickup>
                <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
                <ShippingService> token </ShippingService>
                <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
                <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
                <ShippingServicePriority> int </ShippingServicePriority>
                <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
                <ShippingTimeMax> int </ShippingTimeMax>
                <ShippingTimeMin> int </ShippingTimeMin>
              </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>
          <PickupDetails> PickupDetailsType
            <PickupOptions> PickupOptionsType
              <PickupMethod> token </PickupMethod>
              <PickupPriority> int </PickupPriority>
            </PickupOptions>
            <!-- ... more PickupOptions nodes allowed here ... -->
          </PickupDetails>
          <PickupMethodSelected> PickupMethodSelectedType
            <MerchantPickupCode> string </MerchantPickupCode>
            <PickupLocationUUID> string </PickupLocationUUID>
            <PickupMethod> token </PickupMethod>
            <PickupStatus> PickupStatusCodeType </PickupStatus>
            <PickupStoreID> string </PickupStoreID>
          </PickupMethodSelected>
          <Platform> TransactionPlatformCodeType </Platform>
          <QuantityPurchased> int </QuantityPurchased>
          <ShippedTime> dateTime </ShippedTime>
          <Status> TransactionStatusType
            <CancelStatus> CancelStatusCodeType </CancelStatus>
            <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 </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 </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>
      </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 </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
          <InternationalShippingServiceOption> InternationalShippingServiceOptionsType </InternationalShippingServiceOption>
          <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
          <ShippingServiceOptions> ShippingServiceOptionsType
            <ExpeditedService> boolean </ExpeditedService>
            <FreeShipping> boolean </FreeShipping>
            <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
            <LocalPickup> boolean </LocalPickup>
            <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
            <ShippingService> token </ShippingService>
            <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
            <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
            <ShippingServicePriority> int </ShippingServicePriority>
            <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
            <ShippingTimeMax> int </ShippingTimeMax>
            <ShippingTimeMin> int </ShippingTimeMin>
          </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
          <BuyerPackageEnclosures> BuyerPackageEnclosuresType
            <BuyerPackageEnclosure type="PaymentInstructionCodeType"> BuyerPackageEnclosureType (string) </BuyerPackageEnclosure>
            <!-- ... more BuyerPackageEnclosure values allowed here ... -->
          </BuyerPackageEnclosures>
          <OrderID> OrderIDType (string) </OrderID>
          <PickupDetails> PickupDetailsType
            <PickupOptions> PickupOptionsType
              <PickupMethod> token </PickupMethod>
              <PickupPriority> int </PickupPriority>
            </PickupOptions>
            <!-- ... more PickupOptions nodes allowed here ... -->
          </PickupDetails>
          <PickupMethodSelected> PickupMethodSelectedType
            <MerchantPickupCode> string </MerchantPickupCode>
            <PickupLocationUUID> string </PickupLocationUUID>
            <PickupMethod> token </PickupMethod>
            <PickupStatus> PickupStatusCodeType </PickupStatus>
            <PickupStoreID> string </PickupStoreID>
          </PickupMethodSelected>
          <ShippingDetails> ShippingDetailsType
            <InternationalShippingServiceOption> InternationalShippingServiceOptionsType </InternationalShippingServiceOption>
            <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
            <ShippingServiceOptions> ShippingServiceOptionsType
              <ExpeditedService> boolean </ExpeditedService>
              <FreeShipping> boolean </FreeShipping>
              <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
              <LocalPickup> boolean </LocalPickup>
              <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
              <ShippingService> token </ShippingService>
              <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
              <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
              <ShippingServicePriority> int </ShippingServicePriority>
              <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
              <ShippingTimeMax> int </ShippingTimeMax>
              <ShippingTimeMin> int </ShippingTimeMin>
            </ShippingServiceOptions>
            <!-- ... more ShippingServiceOptions nodes allowed here ... -->
            <ShippingType> ShippingTypeCodeType </ShippingType>
          </ShippingDetails>
          <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 </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
                  <InternationalShippingServiceOption> InternationalShippingServiceOptionsType </InternationalShippingServiceOption>
                  <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
                  <ShippingServiceOptions> ShippingServiceOptionsType
                    <ExpeditedService> boolean </ExpeditedService>
                    <FreeShipping> boolean </FreeShipping>
                    <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
                    <LocalPickup> boolean </LocalPickup>
                    <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
                    <ShippingService> token </ShippingService>
                    <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
                    <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
                    <ShippingServicePriority> int </ShippingServicePriority>
                    <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
                    <ShippingTimeMax> int </ShippingTimeMax>
                    <ShippingTimeMin> int </ShippingTimeMin>
                  </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>
              <PickupDetails> PickupDetailsType
                <PickupOptions> PickupOptionsType
                  <PickupMethod> token </PickupMethod>
                  <PickupPriority> int </PickupPriority>
                </PickupOptions>
                <!-- ... more PickupOptions nodes allowed here ... -->
              </PickupDetails>
              <PickupMethodSelected> PickupMethodSelectedType
                <MerchantPickupCode> string </MerchantPickupCode>
                <PickupLocationUUID> string </PickupLocationUUID>
                <PickupMethod> token </PickupMethod>
                <PickupStatus> PickupStatusCodeType </PickupStatus>
                <PickupStoreID> string </PickupStoreID>
              </PickupMethodSelected>
              <Platform> TransactionPlatformCodeType </Platform>
              <QuantityPurchased> int </QuantityPurchased>
              <ShippedTime> dateTime </ShippedTime>
              <Status> TransactionStatusType
                <CancelStatus> CancelStatusCodeType </CancelStatus>
                <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 </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
              <InternationalShippingServiceOption> InternationalShippingServiceOptionsType </InternationalShippingServiceOption>
              <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
              <ShippingServiceOptions> ShippingServiceOptionsType
                <ExpeditedService> boolean </ExpeditedService>
                <FreeShipping> boolean </FreeShipping>
                <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
                <LocalPickup> boolean </LocalPickup>
                <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
                <ShippingService> token </ShippingService>
                <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
                <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
                <ShippingServicePriority> int </ShippingServicePriority>
                <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
                <ShippingTimeMax> int </ShippingTimeMax>
                <ShippingTimeMin> int </ShippingTimeMin>
              </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>
          <PickupDetails> PickupDetailsType
            <PickupOptions> PickupOptionsType
              <PickupMethod> token </PickupMethod>
              <PickupPriority> int </PickupPriority>
            </PickupOptions>
            <!-- ... more PickupOptions nodes allowed here ... -->
          </PickupDetails>
          <PickupMethodSelected> PickupMethodSelectedType
            <MerchantPickupCode> string </MerchantPickupCode>
            <PickupLocationUUID> string </PickupLocationUUID>
            <PickupMethod> token </PickupMethod>
            <PickupStatus> PickupStatusCodeType </PickupStatus>
            <PickupStoreID> string </PickupStoreID>
          </PickupMethodSelected>
          <Platform> TransactionPlatformCodeType </Platform>
          <QuantityPurchased> int </QuantityPurchased>
          <ShippedTime> dateTime </ShippedTime>
          <Status> TransactionStatusType
            <CancelStatus> CancelStatusCodeType </CancelStatus>
            <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 This container consists of the items on which the eBay user has made Best Offers. This container will be returned if the eBay user has made one or more Best Offers.

This container will not be returned in the response (even if user has made Best Offers) if the DetailLevel value is set to ReturnSummary and the BestOfferList.Include field is omitted or set to false.

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

Note: Historically, the Best Offer feature has not been available for auction listings, but beginning with Version 1027, sellers in the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. The seller can offer Buy It Now or Best Offer in an auction listing, but not both features.

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. This field is also not applicable to the Add/Revise/Relist calls.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.ItemArray.Item
  .BestOfferDetails.BestOffer
  [ attribute currencyID ]
CurrencyCodeType 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. This field is also not applicable to the Add/Revise/Relist calls.

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 is only applicable to the GetMyeBayBuying call, and will not appear in the response if the buyer has not made a Best Offer.

Applicable values: See BestOfferStatus.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.ItemArray.Item
  .BuyItNowPrice
AmountType (double) Conditionally This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored.

The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option.

Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.ItemArray.Item
  .BuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored.

The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option.

Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BestOfferList.ItemArray.Item
  .ItemID
ItemIDType (string) Conditionally The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified.

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. Your code should be prepared to handle IDs of up to 19 digits.
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.

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

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 This container consists of the data associated with photos within the listing. With most eBay sites and categories, a seller can add up to 12 photos to their listings free of charge. These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol.

It is required that all listings have at least one picture. eBay Motors listings can have up to 24 pictures.

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

See:
    Introduction to Pictures in Item Listings
    Adding photos to your listing

BestOfferList.ItemArray.Item
  .PrivateNotes
string Conditionally A note that a user makes on an item from their My eBay account. GetMyeBayBuying and GetMyeBaySelling return this field, and only if you pass in the IncludeNotes field in the request, and set its value to true. This field will only be returned if set for an item, and only returned 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).
BestOfferList.ItemArray.Item
  .Seller
UserType Conditionally Container for information about this listing's seller.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Rating Star value for the user is returned to the buyer or seller, but a dummy value of None will be returned to all third parties.

Applicable values: See FeedbackRatingStar.
Code so that your app gracefully handles any future changes to this list.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.

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

Important: 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, the current high bidder, quantity sold, current price, and listing status.

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

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

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

Shipping details are not applicable to any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not 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
  .InternationalShippingServiceOption
InternationalShippingServiceOptionsType Conditionally,
repeatable: [0..*]
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions.

If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes.

All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing).

If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program) 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.

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.

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
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. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing). 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.

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
  .ExpeditedService
boolean Conditionally Indicates whether the service is an expedited shipping service.
BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .FreeShipping
boolean Conditionally Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service.

If the seller specifies FreeShipping but requires shipping insurance (InsuranceOption = Require), eBay sets the insurance cost to 0.00. However, if shipping insurance is optional and the buyer chooses shipping insurance, eBay preserves the cost of shipping insurance. It is up to the buyer whether to buy shipping insurance, regardless of whether the seller specified FreeShipping.

See Specifying Shipping Services.

BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.

For a list of possible enumeration values, see CurrencyCodeType.
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
  .ShippingInsuranceCost
AmountType (double) Conditionally The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

See Determining Shipping Costs for a Listing.

BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingInsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingService
token Conditionally A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

For flat and calculated shipping.

If there are two or more services and one is "pickup", "pickup" must not be specified as the first service.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

See Determining Shipping Costs for a Listing.

BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
AmountType (double) Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

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

See Determining Shipping Costs for a Listing.

BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

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 a list of possible enumeration values, see CurrencyCodeType.
BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority
int Conditionally Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.

Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

This field is applicable to Flat and Calculated shipping.
BestOfferList.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.
BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
  [ attribute currencyID ]
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMax
int Conditionally The integer value returned here indicates the maximum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
BestOfferList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMin
int Conditionally The integer value returned here indicates the minimum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
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.

GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.

Applicable values: See ShippingType.
Code so that your app gracefully handles any future changes to this list.
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 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 site, the visibility of the item in some types of searches (e.g., GetCategoryListings), 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).

Applicable values: See Site.
Code so that your app gracefully handles any future changes to this list.

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

See:
    eBay Sites and Environments
    Specifying the Target Site
    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).

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

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

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. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ProductListingDetails.

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

The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.

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 This container consists of the auction items on which the eBay user has bid. This container will be returned if the eBay user has bid on one or more auction items.

This container will not be returned in the response (even if there are items on the Bid List) if the DetailLevel value is set to ReturnSummary and the BidList.Include field is omitted or set to false.

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 the 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 Detailed information about a bid. For GetMyeBayBuying, returned as a self-closed element if no bids meet the request criteria.

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

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 This value is the dollar value of the highest bid that the buyer placed on the auction item.

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
  .BiddingDetails.Winning
boolean Conditionally This field is returned as true if the prospective buyer is the current high bidder in an active listing.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item
  .BuyItNowPrice
AmountType (double) Conditionally This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored.

The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option.

Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item
  .BuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored.

The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option.

Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidList.ItemArray.Item.ItemID ItemIDType (string) Conditionally The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified.

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. Your code should be prepared to handle IDs of up to 19 digits.
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.

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

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

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 selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value).

If this field is not included in an AddItem, AddItems, AddSellingManagerTemplate, or VerifyAddItem call, the listing type defaults to auction

For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings.

This field is not applicable to Revise calls because the selling format of active listings cannot be changed.

Applicable values: See ListingType.
Code so that your app gracefully handles any future changes to this list.

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 This container consists of the data associated with photos within the listing. With most eBay sites and categories, a seller can add up to 12 photos to their listings free of charge. These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol.

It is required that all listings have at least one picture. eBay Motors listings can have up to 24 pictures.

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

See:
    Introduction to Pictures in Item Listings
    Adding photos to your listing

BidList.ItemArray.Item
  .PrivateNotes
string Conditionally A note that a user makes on an item from their My eBay account. GetMyeBayBuying and GetMyeBaySelling return this field, and only if you pass in the IncludeNotes field in the request, and set its value to true. This field will only be returned if set for an item, and only returned 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).
BidList.ItemArray.Item.Seller UserType Conditionally Container for information about this listing's seller.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Rating Star value for the user is returned to the buyer or seller, but a dummy value of None will be returned to all third parties.

Applicable values: See FeedbackRatingStar.
Code so that your app gracefully handles any future changes to this list.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.

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

Important: 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, the current high bidder, quantity sold, current price, and listing status.

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

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

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.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Rating Star value for the user is returned to the buyer or seller, but a dummy value of None will be returned to all third parties.

Applicable values: See FeedbackRatingStar.
Code so that your app gracefully handles any future changes to this list.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.

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

Important: 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, 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.

Shipping details are not applicable to any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not 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
  .InternationalShippingServiceOption
InternationalShippingServiceOptionsType Conditionally,
repeatable: [0..*]
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions.

If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes.

All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing).

If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program) 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.

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.

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
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. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing). 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.

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
  .ExpeditedService
boolean Conditionally Indicates whether the service is an expedited shipping service.
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .FreeShipping
boolean Conditionally Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service.

If the seller specifies FreeShipping but requires shipping insurance (InsuranceOption = Require), eBay sets the insurance cost to 0.00. However, if shipping insurance is optional and the buyer chooses shipping insurance, eBay preserves the cost of shipping insurance. It is up to the buyer whether to buy shipping insurance, regardless of whether the seller specified FreeShipping.

See Specifying Shipping Services.

BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.

For a list of possible enumeration values, see CurrencyCodeType.
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
  .ShippingInsuranceCost
AmountType (double) Conditionally The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

See Determining Shipping Costs for a Listing.

BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingInsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingService
token Conditionally A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

For flat and calculated shipping.

If there are two or more services and one is "pickup", "pickup" must not be specified as the first service.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

See Determining Shipping Costs for a Listing.

BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
AmountType (double) Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

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

See Determining Shipping Costs for a Listing.

BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

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 a list of possible enumeration values, see CurrencyCodeType.
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority
int Conditionally Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.

Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

This field is applicable to Flat and Calculated shipping.
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 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.

For a list of possible enumeration values, see CurrencyCodeType.
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMax
int Conditionally The integer value returned here indicates the maximum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
BidList.ItemArray.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMin
int Conditionally The integer value returned here indicates the minimum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
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.

GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.

Applicable values: See ShippingType.
Code so that your app gracefully handles any future changes to this list.
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 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 site, the visibility of the item in some types of searches (e.g., GetCategoryListings), 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).

Applicable values: See Site.
Code so that your app gracefully handles any future changes to this list.

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

See:
    eBay Sites and Environments
    Specifying the Target Site
    Field Differences for eBay Sites

BidList.ItemArray.Item
  .StartPrice
AmountType (double) Conditionally The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

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

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

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.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

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

See Listing Policies.

BidList.ItemArray.Item
  .StartPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

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

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

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.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

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

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

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

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. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ProductListingDetails.

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

The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.

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 This container consists of buying/bidding activity counts and values. For this container to be returned, the user must include the BuyingSummary.Include field in the request and set its value to true.

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 that the user is currently the highest bidder on.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BuyingSummary.TotalWinningCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The total cost of items that the user is currently the highest bidder on.

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

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BuyingSummary.TotalWonCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The total cost of auction items that the user has won.

For a list of possible enumeration values, see CurrencyCodeType.
BuyingSummary.WinningCount int Conditionally The number of active auction listings in which the user is currently the highest bidder.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BuyingSummary.WonCount int Conditionally The number of auction items that the user has 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 This container consists of the auction items on which the eBay user has lost and then deleted from their My eBay page. This container will be returned if the eBay user has lost one or more auction items and then deleted those items from My eBay.

This container will not be returned in the response (even if they have lost and then deleted one or more items) if the DetailLevel value is set to ReturnSummary and the DeletedFromLostList.Include field is omitted or set to false.

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 the 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 Detailed information about a bid. For GetMyeBayBuying, returned as a self-closed element if no bids meet the request criteria.

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

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 This value is the dollar value of the highest bid that the buyer placed on the auction item.

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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.ItemArray
  .Item.ItemID
ItemIDType (string) Conditionally The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified.

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. Your code should be prepared to handle IDs of up to 19 digits.
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.

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

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 selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value).

If this field is not included in an AddItem, AddItems, AddSellingManagerTemplate, or VerifyAddItem call, the listing type defaults to auction

For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings.

This field is not applicable to Revise calls because the selling format of active listings cannot be changed.

Applicable values: See ListingType.
Code so that your app gracefully handles any future changes to this list.

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 This container consists of the data associated with photos within the listing. With most eBay sites and categories, a seller can add up to 12 photos to their listings free of charge. These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol.

It is required that all listings have at least one picture. eBay Motors listings can have up to 24 pictures.

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

See:
    Introduction to Pictures in Item Listings
    Adding photos to your listing

DeletedFromLostList.ItemArray
  .Item.PrivateNotes
string Conditionally A note that a user makes on an item from their My eBay account. GetMyeBayBuying and GetMyeBaySelling return this field, and only if you pass in the IncludeNotes field in the request, and set its value to true. This field will only be returned if set for an item, and only returned 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).
DeletedFromLostList.ItemArray
  .Item.Seller
UserType Conditionally Container for information about this listing's seller.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Rating Star value for the user is returned to the buyer or seller, but a dummy value of None will be returned to all third parties.

Applicable values: See FeedbackRatingStar.
Code so that your app gracefully handles any future changes to this list.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.

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

Important: 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, the current high bidder, quantity sold, current price, and listing status.

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

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

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.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Rating Star value for the user is returned to the buyer or seller, but a dummy value of None will be returned to all third parties.

Applicable values: See FeedbackRatingStar.
Code so that your app gracefully handles any future changes to this list.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.

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

Important: 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, 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.

Shipping details are not applicable to any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not 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.

GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.

Applicable values: See ShippingType.
Code so that your app gracefully handles any future changes to this list.
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 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 site, the visibility of the item in some types of searches (e.g., GetCategoryListings), 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).

Applicable values: See Site.
Code so that your app gracefully handles any future changes to this list.

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

See:
    eBay Sites and Environments
    Specifying the Target Site
    Field Differences for eBay Sites

DeletedFromLostList.ItemArray
  .Item.StartPrice
AmountType (double) Conditionally The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

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

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

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.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

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

See Listing Policies.

DeletedFromLostList.ItemArray
  .Item.StartPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

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

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

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.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

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

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

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. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ProductListingDetails.

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

The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.

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). You also can't add or change variation specifics (because they are unique identifiers). 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 item variation from another. For example, if an item varies 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 item variation, and you might have a plan to add more item variations to the listing in the future. However, if you don't plan to add other item variations in the future, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers.

If you specify multiple Variation containers in an add/revise/relist/verify add call to define multiple item variations, the Variation containers must be contiguous or an error will occur. This means that you would not want to input a Pictures or a VariationSpecificsSet container in between Variation containers in an API call.

When you modify an item variation with a ReviseFixedPriceItem call, the best practice is to include all applicable fields under the Variation container, even if some of the values/settings are not being modified. The StartPrice and VariationSpecifics must be included when modifying an existing item variation, even if these values are not being changed. If a SKU value is defined for the item variation, it is strongly recommended that you include the SKU field, regardless of whether the SKU value is changing or not. If the SKU field is not included, any existing SKU value will be removed from the item variation. It is also strongly recommended that you include the Quantity field and input an accurate value, because if the Quantity field is omitted in the API call, the quantity for the item variation is set to 0.

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:
  • Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
  • Specify up to five VariationSpecifics in each Variation node.
  • 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.

For more details, see Requiring Product Identifiers Mandate

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.ItemArray
  .Item.Variations.Variation
  .VariationSpecifics
  .NameValueList.Name
string Conditionally Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, a Parts Compatibility name, or a product identifier type.

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier type, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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). 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 the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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.

Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromLostList.ItemArray
  .Item.Variations.Variation
  .VariationSpecifics
  .NameValueList.Value
string Conditionally,
repeatable: [0..*]
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.

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

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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 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 the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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: 65.

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 This container consists of the auction items on which the eBay user has won but deleted from their My eBay page. This container will be returned if the eBay user has won one or more auction items but have deleted these items from My eBay.

This container will not be returned in the response (even if they have won and then deleted one or more items) if the DetailLevel value is set to ReturnSummary and the DeletedFromWonList.Include field is omitted or set to false.

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..*]
This container consists of detailed information on a specific order and each order line item in that order.

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
  .BuyerPackageEnclosures
BuyerPackageEnclosuresType Conditionally This container is returned in GetOrders (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order. The 'Pay Upon Invoice' option is only available on the German site.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .BuyerPackageEnclosures
  .BuyerPackageEnclosure
BuyerPackageEnclosureType (string) Conditionally,
repeatable: [0..*]
A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .BuyerPackageEnclosures
  .BuyerPackageEnclosure
  [ attribute type ]
PaymentInstructionCodeType Conditionally A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.

For a list of possible enumeration values, see PaymentInstructionCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .OrderID
OrderIDType (string) Conditionally A unique identifier for an eBay order. For a single line item order, this value is actually the OrderLineItemID value, which is a concatenation of ItemID and TransactionID, with a hyphen in between these two values, such as 121124971073-1094989827002 for a fixed-price listing, or 121124971074-0 for an auction listing. For a multiple line item order (known as a Combined Invoice order), the OrderID value is created by eBay when the buyer/seller combines multiple line items into one order, and the buyer makes one payment for all line items from the same seller. "Combined Invoice" orders are created through the Web flow, or when the buyer or seller creates a "Combined Invoice" order by using the AddOrder call. An example of "Combined Invoice" order ID is 155643809010.

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

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer, seller, or PayPal (if PayPal is the payment method), and no longer returned at all to third parties (except for PayPal). If using a Trading WSDL older than Version 1019, the correct Order ID is returned to the buyer, seller or PayPal, but the Order ID will be returned as dummy data in the form of 1000000000000 or 1000000000000-1000000000000 to all third parties (except for PayPal).

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

See Combined Invoice.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .PickupDetails
PickupDetailsType Conditionally Container consisting of an array of PickupOptions containers. Each PickupOptions container consists of the pickup method and its priority. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page.

For GetOrders and GetOrderTransactions, this container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore and/or EligibleForPickupDropOff flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup or Click and Collect functionality in the Sandbox environment, including listing items enabled with these features, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .PickupDetails.PickupOptions
PickupOptionsType Conditionally,
repeatable: [0..*]
Container consisting of a pickup method and the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page.

This container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore and/or EligibleForPickupDropOff flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container.

Note: At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. In-Store Pickup is only applicable to the US site, and Click and Collect is only applicable to the UK, Germany, and Australia sites.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .PickupDetails.PickupOptions
  .PickupMethod
token Conditionally This value indicates an available pickup method. This field is always returned with the PickupOptions container.

Note: At this time, 'InStorePickup' and 'PickUpDropOff' are the only available pickup methods; however, additional pickup methods may be added to the list in future releases.
Note: A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.

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

Applicable values: See PickupMethodCodeType
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .PickupDetails.PickupOptions
  .PickupPriority
int Conditionally This integer value indicates the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. This field is always returned with the PickupOptions container.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .PickupMethodSelected
PickupMethodSelectedType Conditionally Container consisting of details related to the selected pickup method, including the pickup method type, the merchant's store ID, the status of the pickup, and the pickup reference code (if provided by merchant).

This container is only returned when the buyer has selected the In-Store Pickup or Click and Collect option and has paid for the order. All fields in the PickupMethodSelected container are static, except for the PickupStatus field, which can change states based on the notifications that a merchant sends to eBay through the Inbound Notifications API.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for these features. At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .PickupMethodSelected
  .MerchantPickupCode
string Conditionally The unique reference number defined by the merchant to track In-Store Pickup orders. The MerchantPickupCode is picked up by eBay if it is set by the merchant through the payload of a notification sent to eBay through the Inbound Notifications API. This field is only returned with the PickupMethodSelected container if it set by the merchant.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real reference number is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .PickupMethodSelected
  .PickupLocationUUID
string Conditionally The unique identifier of the merchant's store where the "Click and Collect" item will be picked up. This field will only be returned if supplied by the merchant.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .PickupMethodSelected
  .PickupMethod
token Conditionally This value indicates the local pickup method that was selected by the buyer at checkout. This field is always returned with the PickupMethodSelected container.

Note: Merchants must be eligible for the In-Store Pickup or "Click and Collect" feature to list items that are eligible for these local pickup methods.

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

Applicable values: See PickupMethodCodeType
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .PickupMethodSelected
  .PickupStatus
PickupStatusCodeType Conditionally This field indicates the current status of the local pickup order. The value of the PickupStatus field can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the Inbound Notifications API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for these features. At this time, these features are generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values: See PickupStatus.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .PickupMethodSelected
  .PickupStoreID
string Conditionally The unique identifier of the merchant's store where the item will be picked up. The PickupStoreID is picked up by eBay based on the LocationID value that is set by the merchant in the Inventory Management API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
ShippingDetailsType Conditionally Container consisting of all shipping-related details for an order, including domestic and international shipping service options, shipment tracking information, and shipping insurance information.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .InternationalShippingServiceOption
InternationalShippingServiceOptionsType Conditionally,
repeatable: [0..*]
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions.

If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes.

All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing).

If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program) 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.

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.

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
  .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. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing). 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.

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
  .ShippingDetails
  .ShippingServiceOptions
  .ExpeditedService
boolean Conditionally Indicates whether the service is an expedited shipping service.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .FreeShipping
boolean Conditionally Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service.

If the seller specifies FreeShipping but requires shipping insurance (InsuranceOption = Require), eBay sets the insurance cost to 0.00. However, if shipping insurance is optional and the buyer chooses shipping insurance, eBay preserves the cost of shipping insurance. It is up to the buyer whether to buy shipping insurance, regardless of whether the seller specified FreeShipping.

See Specifying Shipping Services.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .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
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingInsuranceCost
AmountType (double) Conditionally The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

See Determining Shipping Costs for a Listing.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingInsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingService
token Conditionally A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

For flat and calculated shipping.

If there are two or more services and one is "pickup", "pickup" must not be specified as the first service.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

See Determining Shipping Costs for a Listing.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
AmountType (double) Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

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

See Determining Shipping Costs for a Listing.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

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 a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority
int Conditionally Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.

Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

This field is applicable to Flat and Calculated shipping.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
  [ attribute currencyID ]
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMax
int Conditionally The integer value returned here indicates the maximum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMin
int Conditionally The integer value returned here indicates the minimum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .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.

GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.

Applicable values: See ShippingType.
Code so that your app gracefully handles any future changes to this list.
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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .Subtotal
  [ attribute currencyID ]
CurrencyCodeType 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.

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 Invoice order. (In the future, AddOrder may enforce this recommendation.)

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

See Combined Invoice.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
TransactionType Conditionally,
repeatable: [0..*]
A Transaction container is returned for each line item in the order. This container consists of detailed information on one order line item.

For the AddOrder call, a Transaction container is used to identified the unpaid order line items that are being combined into one Combined Invoice order.

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

See Listing an Item.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .BuyerPaidStatus
PaidStatusCodeType Conditionally Specifies the paid status of the order.

Applicable values: See BuyerPaidStatus.
Code so that your app gracefully handles any future changes to this list.

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.

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.

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: See CommentType.
Code so that your app gracefully handles any future changes to this list.

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.

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: See CommentType.
Code so that your app gracefully handles any future changes to this list.

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 return are dependent on the call, the type of item or listing, and the listing site.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.BiddingDetails
BiddingDetailsType Conditionally Detailed information about a bid. For GetMyeBayBuying, returned as a self-closed element if no bids meet the request criteria.

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

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 This value is the dollar value of the highest bid that the buyer placed on the auction item.

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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ItemID
ItemIDType (string) Conditionally The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified.

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. Your code should be prepared to handle IDs of up to 19 digits.
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.

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

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 selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value).

If this field is not included in an AddItem, AddItems, AddSellingManagerTemplate, or VerifyAddItem call, the listing type defaults to auction

For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings.

This field is not applicable to Revise calls because the selling format of active listings cannot be changed.

Applicable values: See ListingType.
Code so that your app gracefully handles any future changes to this list.

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 This container consists of the data associated with photos within the listing. With most eBay sites and categories, a seller can add up to 12 photos to their listings free of charge. These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol.

It is required that all listings have at least one picture. eBay Motors listings can have up to 24 pictures.

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

See:
    Introduction to Pictures in Item Listings
    Adding photos to your listing

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.PrivateNotes
string Conditionally A note that a user makes on an item from their My eBay account. GetMyeBayBuying and GetMyeBaySelling return this field, and only if you pass in the IncludeNotes field in the request, and set its value to true. This field will only be returned if set for an item, and only returned 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).
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Seller
UserType Conditionally Container for information about this listing's seller.

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

Important: 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, the current high bidder, quantity sold, current price, and listing status.

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

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

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

Shipping details are not applicable to any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not 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
  .InternationalShippingServiceOption
InternationalShippingServiceOptionsType Conditionally,
repeatable: [0..*]
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions.

If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes.

All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing).

If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program) 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.

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.

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
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. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing). 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.

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
  .ExpeditedService
boolean Conditionally Indicates whether the service is an expedited shipping service.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .FreeShipping
boolean Conditionally Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service.

If the seller specifies FreeShipping but requires shipping insurance (InsuranceOption = Require), eBay sets the insurance cost to 0.00. However, if shipping insurance is optional and the buyer chooses shipping insurance, eBay preserves the cost of shipping insurance. It is up to the buyer whether to buy shipping insurance, regardless of whether the seller specified FreeShipping.

See Specifying Shipping Services.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.

For a list of possible enumeration values, see CurrencyCodeType.
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
  .ShippingInsuranceCost
AmountType (double) Conditionally The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

See Determining Shipping Costs for a Listing.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingInsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingService
token Conditionally A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

For flat and calculated shipping.

If there are two or more services and one is "pickup", "pickup" must not be specified as the first service.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

See Determining Shipping Costs for a Listing.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
AmountType (double) Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

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

See Determining Shipping Costs for a Listing.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

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 a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority
int Conditionally Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.

Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

This field is applicable to Flat and Calculated shipping.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
  [ attribute currencyID ]
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMax
int Conditionally The integer value returned here indicates the maximum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMin
int Conditionally The integer value returned here indicates the minimum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
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.

GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.

Applicable values: See ShippingType.
Code so that your app gracefully handles any future changes to this list.
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 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 site, the visibility of the item in some types of searches (e.g., GetCategoryListings), 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).

Applicable values: See Site.
Code so that your app gracefully handles any future changes to this list.

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

See:
    eBay Sites and Environments
    Specifying the Target Site
    Field Differences for eBay Sites

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.StartPrice
AmountType (double) Conditionally The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

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

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

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.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

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 The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

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

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

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.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

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

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

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. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ProductListingDetails.

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

The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.

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). You also can't add or change variation specifics (because they are unique identifiers). 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 item variation from another. For example, if an item varies 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 item variation, and you might have a plan to add more item variations to the listing in the future. However, if you don't plan to add other item variations in the future, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers.

If you specify multiple Variation containers in an add/revise/relist/verify add call to define multiple item variations, the Variation containers must be contiguous or an error will occur. This means that you would not want to input a Pictures or a VariationSpecificsSet container in between Variation containers in an API call.

When you modify an item variation with a ReviseFixedPriceItem call, the best practice is to include all applicable fields under the Variation container, even if some of the values/settings are not being modified. The StartPrice and VariationSpecifics must be included when modifying an existing item variation, even if these values are not being changed. If a SKU value is defined for the item variation, it is strongly recommended that you include the SKU field, regardless of whether the SKU value is changing or not. If the SKU field is not included, any existing SKU value will be removed from the item variation. It is also strongly recommended that you include the Quantity field and input an accurate value, because if the Quantity field is omitted in the API call, the quantity for the item variation is set to 0.

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:
  • Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
  • Specify up to five VariationSpecifics in each Variation node.
  • 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.

For more details, see Requiring Product Identifiers Mandate

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 Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, a Parts Compatibility name, or a product identifier type.

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier type, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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). 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 the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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.

Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.

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..*]
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.

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

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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 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 the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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: 65.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, order line item ID is only returned to the buyer or seller, and a dummy value of 10000000000000 will be returned to all third parties.

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 field is not returned until payment has been made by the buyer. This field will not be returned for orders where the buyer has received partial or full refunds.

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.


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
  .PickupDetails
PickupDetailsType Conditionally Container consisting of an array of PickupOptions containers. Each PickupOptions container consists of the pickup method and its priority. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. With this initial version of In-Store Pickup, the only pickup method is 'InStorePickup'.

For GetOrders and GetOrderTransactions, this container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore flag in the call request set to 'true'. If and when the In-Store pickup method is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .PickupDetails.PickupOptions
PickupOptionsType Conditionally,
repeatable: [0..*]
Container consisting of a pickup method and the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page.

This container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore and/or EligibleForPickupDropOff flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container.

Note: At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. In-Store Pickup is only applicable to the US site, and Click and Collect is only applicable to the UK, Germany, and Australia sites.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .PickupDetails.PickupOptions
  .PickupMethod
token Conditionally This value indicates an available pickup method. This field is always returned with the PickupOptions container.

Note: At this time, 'InStorePickup' and 'PickUpDropOff' are the only available pickup methods; however, additional pickup methods may be added to the list in future releases.
Note: A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.

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

Applicable values: See PickupMethodCodeType
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .PickupDetails.PickupOptions
  .PickupPriority
int Conditionally This integer value indicates the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. This field is always returned with the PickupOptions container.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .PickupMethodSelected
PickupMethodSelectedType Conditionally This container consists of details related to the selected In-Store pickup method, including the pickup method, the merchant's store ID, the status of the In-Store pickup, and the pickup reference code (if provided by merchant).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .PickupMethodSelected
  .MerchantPickupCode
string Conditionally The unique reference number defined by the merchant to track In-Store Pickup orders. The MerchantPickupCode is picked up by eBay if it is set by the merchant through the payload of a notification sent to eBay through the Inbound Notifications API. This field is only returned with the PickupMethodSelected container if it set by the merchant.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real reference number is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .PickupMethodSelected
  .PickupLocationUUID
string Conditionally The unique identifier of the merchant's store where the "Click and Collect" item will be picked up. This field will only be returned if supplied by the merchant.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .PickupMethodSelected
  .PickupMethod
token Conditionally This value indicates the local pickup method that was selected by the buyer at checkout. This field is always returned with the PickupMethodSelected container.

Note: Merchants must be eligible for the In-Store Pickup or "Click and Collect" feature to list items that are eligible for these local pickup methods.

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

Applicable values: See PickupMethodCodeType
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .PickupMethodSelected
  .PickupStatus
PickupStatusCodeType Conditionally This field indicates the current status of the local pickup order. The value of the PickupStatus field can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the Inbound Notifications API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for these features. At this time, these features are generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values: See PickupStatus.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .PickupMethodSelected
  .PickupStoreID
string Conditionally The unique identifier of the merchant's store where the item will be picked up. The PickupStoreID is picked up by eBay based on the LocationID value that is set by the merchant in the Inventory Management API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Platform
TransactionPlatformCodeType Conditionally This value indicates the site on which the order line item originated.

Note: Currently, the only value that should be returned in this field is eBay, as Half.com listings will no longer be supported in APIs.

Applicable values:

eBay
(in/out) This value indicates the purchase occurred on an eBay marketplace site.

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

Code so that your app gracefully handles any future changes to this list.

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.

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.

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 PaymentHoldStatus child elements are returned. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Status.CancelStatus
CancelStatusCodeType Conditionally The current status for the order cancellation request if it exists. This field is only returned if a cancellation request has been made on an order, or if the order is currently going through the cancellation process, or if the order has already been cancelled.

Applicable values: See CancelStatus.
Code so that your app gracefully handles any future changes to this list.

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: See PaymentHoldStatus.
Code so that your app gracefully handles any future changes to this list.

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. Before payment, this dollar value will be the price before a shipping service option is selected. Once a shipping service option is selected, the price in this field will be updated to reflect the shipping and handling costs associated with that shipping service option.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .TotalPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally This field indicates the total price for an order line item. Before payment, this dollar value will be the price before a shipping service option is selected. Once a shipping service option is selected, the price in this field will be updated to reflect the shipping and handling costs associated with that shipping service option.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .TotalTransactionPrice
AmountType (double) Conditionally The sale price of the order line item. This amount does not take into account shipping and handling charges, sales tax, or any other costs related to the order line item. If multiple units were purchased through a non- variation, fixed-price listing, this value will reflect that. So, if the base cost of the order line item was $15.00, and a quantity of two were purchased (Transaction.QuantityPurchased) the value in this field would show as 30.00.

To see the full price of the order line item, including any shipping and handling charges, and any sales tax, the (Transaction.TotalPrice) field value should be viewed instead. However, note that the TotalPrice field value is only updated after a shipping service option is selected and payment is made. And if the seller is offering free shipping, the values in the TotalTransactionPrice and the TotalPrice fields may be the same.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .TotalTransactionPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The sale price of the order line item. This amount does not take into account shipping and handling charges, sales tax, or any other costs related to the order line item. If multiple units were purchased through a non- variation, fixed-price listing, this value will reflect that. So, if the base cost of the order line item was $15.00, and a quantity of two were purchased (Transaction.QuantityPurchased) the value in this field would show as 30.00.

To see the full price of the order line item, including any shipping and handling charges, and any sales tax, the (Transaction.TotalPrice) field value should be viewed instead. However, note that the TotalPrice field value is only updated after a shipping service option is selected and payment is made. And if the seller is offering free shipping, the values in the TotalTransactionPrice and the TotalPrice fields may be the same.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer, seller, or PayPal (if payment method is PayPal), and no longer returned at all to third parties (except for PayPal). If using a Trading WSDL older than Version 1019, transaction ID is only returned to the buyer, seller or PayPal, and a dummy value of 10000000000000 will be returned to all third parties (except for PayPal).
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 Specifies the paid status of the order.

Applicable values: See BuyerPaidStatus.
Code so that your app gracefully handles any future changes to this list.

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.

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.

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: See CommentType.
Code so that your app gracefully handles any future changes to this list.

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.

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: See CommentType.
Code so that your app gracefully handles any future changes to this list.

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 return are dependent on the call, the type of item or listing, and the listing site.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.BiddingDetails
BiddingDetailsType Conditionally Detailed information about a bid. For GetMyeBayBuying, returned as a self-closed element if no bids meet the request criteria.

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

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 This value is the dollar value of the highest bid that the buyer placed on the auction item.

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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ItemID
ItemIDType (string) Conditionally The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified.

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. Your code should be prepared to handle IDs of up to 19 digits.
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.

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

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 selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value).

If this field is not included in an AddItem, AddItems, AddSellingManagerTemplate, or VerifyAddItem call, the listing type defaults to auction

For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings.

This field is not applicable to Revise calls because the selling format of active listings cannot be changed.

Applicable values: See ListingType.
Code so that your app gracefully handles any future changes to this list.

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 This container consists of the data associated with photos within the listing. With most eBay sites and categories, a seller can add up to 12 photos to their listings free of charge. These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol.

It is required that all listings have at least one picture. eBay Motors listings can have up to 24 pictures.

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

See:
    Introduction to Pictures in Item Listings
    Adding photos to your listing

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.PrivateNotes
string Conditionally A note that a user makes on an item from their My eBay account. GetMyeBayBuying and GetMyeBaySelling return this field, and only if you pass in the IncludeNotes field in the request, and set its value to true. This field will only be returned if set for an item, and only returned 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).
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Seller
UserType Conditionally Container for information about this listing's seller.

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

Important: 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, the current high bidder, quantity sold, current price, and listing status.

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

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

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

Shipping details are not applicable to any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not 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
  .InternationalShippingServiceOption
InternationalShippingServiceOptionsType Conditionally,
repeatable: [0..*]
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions.

If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes.

All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing).

If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program) 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.

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.

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
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. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing). 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.

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
  .ExpeditedService
boolean Conditionally Indicates whether the service is an expedited shipping service.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .FreeShipping
boolean Conditionally Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service.

If the seller specifies FreeShipping but requires shipping insurance (InsuranceOption = Require), eBay sets the insurance cost to 0.00. However, if shipping insurance is optional and the buyer chooses shipping insurance, eBay preserves the cost of shipping insurance. It is up to the buyer whether to buy shipping insurance, regardless of whether the seller specified FreeShipping.

See Specifying Shipping Services.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.

For a list of possible enumeration values, see CurrencyCodeType.
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
  .ShippingInsuranceCost
AmountType (double) Conditionally The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

See Determining Shipping Costs for a Listing.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingInsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingService
token Conditionally A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

For flat and calculated shipping.

If there are two or more services and one is "pickup", "pickup" must not be specified as the first service.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

See Determining Shipping Costs for a Listing.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
AmountType (double) Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

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

See Determining Shipping Costs for a Listing.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

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 a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority
int Conditionally Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.

Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

This field is applicable to Flat and Calculated shipping.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
  [ attribute currencyID ]
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMax
int Conditionally The integer value returned here indicates the maximum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMin
int Conditionally The integer value returned here indicates the minimum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
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.

GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.

Applicable values: See ShippingType.
Code so that your app gracefully handles any future changes to this list.
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 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 site, the visibility of the item in some types of searches (e.g., GetCategoryListings), 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).

Applicable values: See Site.
Code so that your app gracefully handles any future changes to this list.

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

See:
    eBay Sites and Environments
    Specifying the Target Site
    Field Differences for eBay Sites

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.StartPrice
AmountType (double) Conditionally The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

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

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

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.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

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

See Listing Policies.

DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.StartPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

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

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

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.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

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

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

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. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ProductListingDetails.

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

The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.

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). You also can't add or change variation specifics (because they are unique identifiers). 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 item variation from another. For example, if an item varies 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 item variation, and you might have a plan to add more item variations to the listing in the future. However, if you don't plan to add other item variations in the future, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers.

If you specify multiple Variation containers in an add/revise/relist/verify add call to define multiple item variations, the Variation containers must be contiguous or an error will occur. This means that you would not want to input a Pictures or a VariationSpecificsSet container in between Variation containers in an API call.

When you modify an item variation with a ReviseFixedPriceItem call, the best practice is to include all applicable fields under the Variation container, even if some of the values/settings are not being modified. The StartPrice and VariationSpecifics must be included when modifying an existing item variation, even if these values are not being changed. If a SKU value is defined for the item variation, it is strongly recommended that you include the SKU field, regardless of whether the SKU value is changing or not. If the SKU field is not included, any existing SKU value will be removed from the item variation. It is also strongly recommended that you include the Quantity field and input an accurate value, because if the Quantity field is omitted in the API call, the quantity for the item variation is set to 0.

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:
  • Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
  • Specify up to five VariationSpecifics in each Variation node.
  • 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.

For more details, see Requiring Product Identifiers Mandate

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Variations.Variation
  .VariationSpecifics
  .NameValueList.Name
string Conditionally Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, a Parts Compatibility name, or a product identifier type.

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier type, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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). 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 the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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.

Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.

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..*]
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.

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

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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 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 the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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: 65.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, order line item ID is only returned to the buyer or seller, and a dummy value of 10000000000000 will be returned to all third parties.

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 field is not returned until payment has been made by the buyer. This field will not be returned for orders where the buyer has received partial or full refunds.

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.


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
  .PickupDetails
PickupDetailsType Conditionally Container consisting of an array of PickupOptions containers. Each PickupOptions container consists of the pickup method and its priority. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. With this initial version of In-Store Pickup, the only pickup method is 'InStorePickup'.

For GetOrders and GetOrderTransactions, this container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore flag in the call request set to 'true'. If and when the In-Store pickup method is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .PickupDetails.PickupOptions
PickupOptionsType Conditionally,
repeatable: [0..*]
Container consisting of a pickup method and the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page.

This container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore and/or EligibleForPickupDropOff flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container.

Note: At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. In-Store Pickup is only applicable to the US site, and Click and Collect is only applicable to the UK, Germany, and Australia sites.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .PickupDetails.PickupOptions
  .PickupMethod
token Conditionally This value indicates an available pickup method. This field is always returned with the PickupOptions container.

Note: At this time, 'InStorePickup' and 'PickUpDropOff' are the only available pickup methods; however, additional pickup methods may be added to the list in future releases.
Note: A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.

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

Applicable values: See PickupMethodCodeType
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .PickupDetails.PickupOptions
  .PickupPriority
int Conditionally This integer value indicates the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. This field is always returned with the PickupOptions container.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .PickupMethodSelected
PickupMethodSelectedType Conditionally This container consists of details related to the selected In-Store pickup method, including the pickup method, the merchant's store ID, the status of the In-Store pickup, and the pickup reference code (if provided by merchant).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .PickupMethodSelected
  .MerchantPickupCode
string Conditionally The unique reference number defined by the merchant to track In-Store Pickup orders. The MerchantPickupCode is picked up by eBay if it is set by the merchant through the payload of a notification sent to eBay through the Inbound Notifications API. This field is only returned with the PickupMethodSelected container if it set by the merchant.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real reference number is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .PickupMethodSelected
  .PickupLocationUUID
string Conditionally The unique identifier of the merchant's store where the "Click and Collect" item will be picked up. This field will only be returned if supplied by the merchant.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .PickupMethodSelected
  .PickupMethod
token Conditionally This value indicates the local pickup method that was selected by the buyer at checkout. This field is always returned with the PickupMethodSelected container.

Note: Merchants must be eligible for the In-Store Pickup or "Click and Collect" feature to list items that are eligible for these local pickup methods.

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

Applicable values: See PickupMethodCodeType
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .PickupMethodSelected
  .PickupStatus
PickupStatusCodeType Conditionally This field indicates the current status of the local pickup order. The value of the PickupStatus field can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the Inbound Notifications API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for these features. At this time, these features are generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values: See PickupStatus.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .PickupMethodSelected
  .PickupStoreID
string Conditionally The unique identifier of the merchant's store where the item will be picked up. The PickupStoreID is picked up by eBay based on the LocationID value that is set by the merchant in the Inventory Management API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Platform
TransactionPlatformCodeType Conditionally This value indicates the site on which the order line item originated.

Note: Currently, the only value that should be returned in this field is eBay, as Half.com listings will no longer be supported in APIs.

Applicable values:

eBay
(in/out) This value indicates the purchase occurred on an eBay marketplace site.

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

Code so that your app gracefully handles any future changes to this list.

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.

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.

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 PaymentHoldStatus child elements are returned. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Status.CancelStatus
CancelStatusCodeType Conditionally The current status for the order cancellation request if it exists. This field is only returned if a cancellation request has been made on an order, or if the order is currently going through the cancellation process, or if the order has already been cancelled.

Applicable values: See CancelStatus.
Code so that your app gracefully handles any future changes to this list.

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: See PaymentHoldStatus.
Code so that your app gracefully handles any future changes to this list.

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. Before payment, this dollar value will be the price before a shipping service option is selected. Once a shipping service option is selected, the price in this field will be updated to reflect the shipping and handling costs associated with that shipping service option.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .TotalPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally This field indicates the total price for an order line item. Before payment, this dollar value will be the price before a shipping service option is selected. Once a shipping service option is selected, the price in this field will be updated to reflect the shipping and handling costs associated with that shipping service option.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .TotalTransactionPrice
AmountType (double) Conditionally The sale price of the order line item. This amount does not take into account shipping and handling charges, sales tax, or any other costs related to the order line item. If multiple units were purchased through a non- variation, fixed-price listing, this value will reflect that. So, if the base cost of the order line item was $15.00, and a quantity of two were purchased (Transaction.QuantityPurchased) the value in this field would show as 30.00.

To see the full price of the order line item, including any shipping and handling charges, and any sales tax, the (Transaction.TotalPrice) field value should be viewed instead. However, note that the TotalPrice field value is only updated after a shipping service option is selected and payment is made. And if the seller is offering free shipping, the values in the TotalTransactionPrice and the TotalPrice fields may be the same.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromWonList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .TotalTransactionPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The sale price of the order line item. This amount does not take into account shipping and handling charges, sales tax, or any other costs related to the order line item. If multiple units were purchased through a non- variation, fixed-price listing, this value will reflect that. So, if the base cost of the order line item was $15.00, and a quantity of two were purchased (Transaction.QuantityPurchased) the value in this field would show as 30.00.

To see the full price of the order line item, including any shipping and handling charges, and any sales tax, the (Transaction.TotalPrice) field value should be viewed instead. However, note that the TotalPrice field value is only updated after a shipping service option is selected and payment is made. And if the seller is offering free shipping, the values in the TotalTransactionPrice and the TotalPrice fields may be the same.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer, seller, or PayPal (if payment method is PayPal), and no longer returned at all to third parties (except for PayPal). If using a Trading WSDL older than Version 1019, transaction ID is only returned to the buyer, seller or PayPal, and a dummy value of 10000000000000 will be returned to all third parties (except for PayPal).
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 This container consists of the eBay user's saved searches. This container will be returned if the eBay user has one or more saved searches.

This container will not be returned in the response (even if the user has saved searches) if the DetailLevel value is set to ReturnSummary and the FavoriteSearches.Include field is omitted or set to false.

This container consists of the search name, search query, and other search elements. The user can copy and paste the URL in the SearchQuery field into a browser to view the search results again.

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

Code so that your app gracefully handles any future changes to this list.

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.
Code so that your app gracefully handles any future changes to this list.

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.
Code so that your app gracefully handles any future changes to this list.

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.
Code so that your app gracefully handles any future changes to this list.

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: See ItemSort.
Code so that your app gracefully handles any future changes to this list.

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: See ItemType.
Code so that your app gracefully handles any future changes to this list.

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

Code so that your app gracefully handles any future changes to this list.

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: See PreferredLocation.
Code so that your app gracefully handles any future changes to this list.

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

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

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: See QuantityOperator.
Code so that your app gracefully handles any future changes to this list.

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: See SearchFlag.
Code so that your app gracefully handles any future changes to this list.

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.

Code so that your app gracefully handles any future changes to this list.

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 key 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 key in descending (high to low) order.

Code so that your app gracefully handles any future changes to this list.

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 This container consists of the eBay user's saved sellers. This container will be returned if the eBay user has one or more saved sellers.

This container will not be returned in the response (even if the user has saved sellers) if the DetailLevel value is set to ReturnSummary and the FavoriteSellers.Include field is omitted or set to false.

This container consists of the saved sellers' user IDs and eBay Store names (if applicable).

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 This container consists of the auction items on which the eBay user has bid on but lost. This container will be returned if the eBay user has lost one or more auction items.

This container will not be returned in the response (even if the buyer has lost one or more auction items) if the DetailLevel value is set to ReturnSummary and the LostList.Include field is omitted or set to false.

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 the 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 Detailed information about a bid. For GetMyeBayBuying, returned as a self-closed element if no bids meet the request criteria.

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

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 This value is the dollar value of the highest bid that the buyer placed on the auction item.

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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
LostList.ItemArray.Item.ItemID ItemIDType (string) Conditionally The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified.

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. Your code should be prepared to handle IDs of up to 19 digits.
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.

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.

DetailLev