eBay Trading APIVersion 1039

GetMyeBaySelling

Use this call to retrieve information from the All Selling section of the authenticated user's My eBay account. You can review items that the user is currently selling (the Active list), items that have bids, sold items, and unsold items. You can also return a items that the user has deleted from their sold and unsold lists, and items that have been scheduled but are not yet active.

GetMyeBaySelling 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 selling information you want to inspect, GetMyeBaySelling can return any combination of selling 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 currently for sale:

  <ActiveList>
    <Include>true</Include>
  </ActiveList>

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

However, that SellingSummary is not automatically returned when DetailLevel is set to ReturnAll; if you want a selling summary returned, you must specify the container in the request.

Note: GetMyeBaySelling has a limit of 25,000 items. If the seller has more than 25,000 listings, the response always returns the following fields.

   <TotalNumberOfPages>125</TotalNumberOfPages>
   <TotalNumberOfEntries>25000</TotalNumberOfEntries>

Any value larger than 125 in the PageNumber field, returns page 125.

Testing GetMyeBaySelling

You can test GetMyeBaySelling 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 a registered Sandbox user. Have one or more different users place bids on the listings, then end the listings with sold and unsold items.

Make sure that items returned in ScheduledList or ActiveList are for scheduled or active listings, respectively. Also, ensure that items returned in SoldList and UnsoldList containers 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 SoldList or UnsoldList using a DurationInDays value. Check the user's My eBay in the Sandbox user interface to make sure the correct number of items is returned.

Related Information

See:
    My eBay
    Managing Selling and Reminders with 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"?>
<GetMyeBaySellingRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <ActiveList> ItemListCustomizationType
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <ListingType> ListingTypeCodeType </ListingType>
    <Pagination> PaginationType
      <EntriesPerPage> int </EntriesPerPage>
      <PageNumber> int </PageNumber>
    </Pagination>
    <Sort> ItemSortTypeCodeType </Sort>
  </ActiveList>
  <DeletedFromSoldList> ItemListCustomizationType
    <DurationInDays> int </DurationInDays>
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <Sort> ItemSortTypeCodeType </Sort>
  </DeletedFromSoldList>
  <DeletedFromUnsoldList> ItemListCustomizationType
    <DurationInDays> int </DurationInDays>
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <Sort> ItemSortTypeCodeType </Sort>
  </DeletedFromUnsoldList>
  <HideVariations> boolean </HideVariations>
  <ScheduledList> ItemListCustomizationType
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <Pagination> PaginationType
      <EntriesPerPage> int </EntriesPerPage>
      <PageNumber> int </PageNumber>
    </Pagination>
    <Sort> ItemSortTypeCodeType </Sort>
  </ScheduledList>
  <SellingSummary> ItemListCustomizationType
    <Include> boolean </Include>
  </SellingSummary>
  <SoldList> ItemListCustomizationType
    <DurationInDays> int </DurationInDays>
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <OrderStatusFilter> OrderStatusFilterCodeType </OrderStatusFilter>
    <Pagination> PaginationType
      <EntriesPerPage> int </EntriesPerPage>
      <PageNumber> int </PageNumber>
    </Pagination>
    <Sort> ItemSortTypeCodeType </Sort>
  </SoldList>
  <UnsoldList> ItemListCustomizationType
    <DurationInDays> int </DurationInDays>
    <Include> boolean </Include>
    <IncludeNotes> boolean </IncludeNotes>
    <Pagination> PaginationType
      <EntriesPerPage> int </EntriesPerPage>
      <PageNumber> int </PageNumber>
    </Pagination>
    <Sort> ItemSortTypeCodeType </Sort>
  </UnsoldList>
  <!-- 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>
</GetMyeBaySellingRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
ActiveList ItemListCustomizationType Optional Include this container and set the ActiveList.Include field to true to return the list of active listings on eBay.com.

The user also has the option of using pagination and sorting for the list of active listings that will be returned.
ActiveList.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.
ActiveList.IncludeNotes boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
ActiveList.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.)
ActiveList.Pagination PaginationType Optional Specifies how to create virtual pages in the returned list.
Default for EntriesPerPage with GetMyeBayBuying is 200.
ActiveList.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.
ActiveList.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.
ActiveList.Sort ItemSortTypeCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values: See Sort.
DeletedFromSoldList ItemListCustomizationType Optional Include this container and set the DeletedFromSoldList.Include field to true to return the list of sold order line items that have since been deleted from the seller's My eBay page.

The user also has the option of using pagination and sorting for the list of deleted, sold items that will be returned.
DeletedFromSoldList
  .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.
DeletedFromSoldList.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.
DeletedFromSoldList
  .IncludeNotes
boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
DeletedFromSoldList.Sort ItemSortTypeCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values: See Sort.
DeletedFromUnsoldList ItemListCustomizationType Optional Include this container and set the DeletedFromUnsoldList.Include field to true to return the list of unsold order line items that have since been deleted from the seller's My eBay page.

The user also has the option of using pagination and sorting for the list of deleted, unsold items that will be returned.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList.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.
DeletedFromUnsoldList
  .IncludeNotes
boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
DeletedFromUnsoldList.Sort ItemSortTypeCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values: See Sort.
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.
ScheduledList ItemListCustomizationType Optional Include this container and set the ScheduledList.Include field to true to return the list of items that are scheduled to become active listings on eBay.com at a future date/time.

The user also has the option of using pagination and sorting for the list of Scheduled listings that will be returned.
ScheduledList.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.
ScheduledList.IncludeNotes boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
ScheduledList.Pagination PaginationType Optional Specifies how to create virtual pages in the returned list.
Default for EntriesPerPage with GetMyeBayBuying is 200.
ScheduledList.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.
ScheduledList.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.
ScheduledList.Sort ItemSortTypeCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values: See Sort.
SellingSummary ItemListCustomizationType Optional Include this container and set the SellingSummary.Include field to true to return the SellingSummary container in the response. The SellingSummary container consists of selling activity counts and values.
SellingSummary.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.
SoldList ItemListCustomizationType Optional Include this container and set the SoldList.Include field to true to return the list of sold order line items.

The user also has the option of using pagination and sorting for the list of sold items that will be returned.
SoldList.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.
SoldList.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.
SoldList.IncludeNotes boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
SoldList.OrderStatusFilter OrderStatusFilterCodeType Optional Filter to reduce the SoldList response based on whether the seller (or eBay) marked the applicable order as Paid and/or Shipped in My eBay.

(Sellers can use CompleteSale or the eBay Web site UI to mark an order as Paid or Shipped in My eBay. Sellers can also specify PaymentStatus in ReviseCheckoutStatus to mark an order as Paid or awaiting payment in My eBay.)
Default: All.

Applicable values:

All
(in) All applicable sold listings, regardless of their Paid or Shipped status.
AwaitingPayment
(in) Sold listings that have not yet been marked as Paid in My eBay.
AwaitingShipment
(in) Sold listings that have not yet been marked as Shipped in My eBay.
CustomCode
(in) Reserved for future or internal use.
PaidAndShipped
(in) Sold listings that have been marked as Paid and Shipped in My eBay.
SoldList.Pagination PaginationType Optional Specifies how to create virtual pages in the returned list.
Default for EntriesPerPage with GetMyeBayBuying is 200.
SoldList.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.
SoldList.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.
SoldList.Sort ItemSortTypeCodeType Optional Specifies the sort order of the result. Default is Ascending.

Applicable values: See Sort.
UnsoldList ItemListCustomizationType Optional Include this container and set the UnsoldList.Include field to true to return the listings that have ended without a purchase.

The user also has the option of using pagination and sorting for the list of unsold items that will be returned.
UnsoldList.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.
UnsoldList.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.
UnsoldList.IncludeNotes boolean Optional Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response.
Default: false.
UnsoldList.Pagination PaginationType Optional Specifies how to create virtual pages in the returned list.
Default for EntriesPerPage with GetMyeBayBuying is 200.
UnsoldList.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.
UnsoldList.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.
UnsoldList.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"?>
<GetMyeBaySellingResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <ActiveList> PaginatedItemArrayType
    <ItemArray> ItemArrayType
      <Item> ItemType
        <BestOfferDetails> BestOfferDetailsType
          <BestOfferCount> int </BestOfferCount>
        </BestOfferDetails>
        <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
        <ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
        <eBayNotes> string </eBayNotes>
        <HideFromSearch> boolean </HideFromSearch>
        <ItemID> ItemIDType (string) </ItemID>
        <LeadCount> int </LeadCount>
        <ListingDetails> ListingDetailsType
          <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
          <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
          <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
          <StartTime> dateTime </StartTime>
        </ListingDetails>
        <ListingDuration> token </ListingDuration>
        <ListingType> ListingTypeCodeType </ListingType>
        <NewLeadCount> int </NewLeadCount>
        <PictureDetails> PictureDetailsType </PictureDetails>
        <PrivateNotes> string </PrivateNotes>
        <Quantity> int </Quantity>
        <QuantityAvailable> int </QuantityAvailable>
        <QuestionCount> long </QuestionCount>
        <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch>
        <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
        <SellerProfiles> SellerProfilesType
          <SellerPaymentProfile> SellerPaymentProfileType
            <PaymentProfileID> long </PaymentProfileID>
            <PaymentProfileName> string </PaymentProfileName>
          </SellerPaymentProfile>
          <SellerReturnProfile> SellerReturnProfileType
            <ReturnProfileID> long </ReturnProfileID>
            <ReturnProfileName> string </ReturnProfileName>
          </SellerReturnProfile>
          <SellerShippingProfile> SellerShippingProfileType
            <ShippingProfileID> long </ShippingProfileID>
            <ShippingProfileName> string </ShippingProfileName>
          </SellerShippingProfile>
        </SellerProfiles>
        <SellingStatus> SellingStatusType
          <BidCount> int </BidCount>
          <BidderCount> long </BidderCount>
          <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>
          <QuantitySold> int </QuantitySold>
          <ReserveMet> boolean </ReserveMet>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType
          <GlobalShipping> boolean </GlobalShipping>
          <ShippingServiceOptions> ShippingServiceOptionsType
            <LocalPickup> boolean </LocalPickup>
            <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          </ShippingServiceOptions>
          <!-- ... more ShippingServiceOptions nodes allowed here ... -->
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <SKU> SKUType (string) </SKU>
        <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
        <TimeLeft> duration </TimeLeft>
        <Title> string </Title>
        <Variations> VariationsType
          <Variation> VariationType
            <PrivateNotes> string </PrivateNotes>
            <Quantity> int </Quantity>
            <SellingStatus> SellingStatusType
              <BidCount> int </BidCount>
              <BidderCount> long </BidderCount>
              <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>
              <QuantitySold> int </QuantitySold>
              <ReserveMet> boolean </ReserveMet>
            </SellingStatus>
            <SKU> SKUType (string) </SKU>
            <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
            <VariationSpecifics> NameValueListArrayType
              <NameValueList> NameValueListType
                <Name> string </Name>
                <Value> string </Value>
                <!-- ... more Value values allowed here ... -->
              </NameValueList>
              <!-- ... more NameValueList nodes allowed here ... -->
            </VariationSpecifics>
            <!-- ... more VariationSpecifics nodes allowed here ... -->
            <VariationTitle> string </VariationTitle>
            <WatchCount> long </WatchCount>
          </Variation>
          <!-- ... more Variation nodes allowed here ... -->
        </Variations>
        <WatchCount> long </WatchCount>
      </Item>
      <!-- ... more Item nodes allowed here ... -->
    </ItemArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </ActiveList>
  <DeletedFromSoldList> PaginatedOrderTransactionArrayType
    <OrderTransactionArray> OrderTransactionArrayType
      <OrderTransaction> OrderTransactionType
        <Order> OrderType
          <OrderID> OrderIDType (string) </OrderID>
          <Subtotal currencyID="CurrencyCodeType"> AmountType (double) </Subtotal>
          <TransactionArray> TransactionArrayType
            <Transaction> TransactionType
              <Buyer> UserType
                <BuyerInfo> BuyerType
                  <ShippingAddress> AddressType
                    <PostalCode> string </PostalCode>
                  </ShippingAddress>
                </BuyerInfo>
                <Email> string </Email>
                <StaticAlias> string </StaticAlias>
                <UserID> UserIDType (string) </UserID>
              </Buyer>
              <ConvertedTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedTransactionPrice>
              <CreatedDate> dateTime </CreatedDate>
              <FeedbackLeft> FeedbackInfoType
                <CommentType> CommentTypeCodeType </CommentType>
              </FeedbackLeft>
              <FeedbackReceived> FeedbackInfoType
                <CommentType> CommentTypeCodeType </CommentType>
              </FeedbackReceived>
              <IsMultiLegShipping> boolean </IsMultiLegShipping>
              <Item> ItemType
                <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
                <ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
                <HideFromSearch> boolean </HideFromSearch>
                <ItemID> ItemIDType (string) </ItemID>
                <ListingDetails> ListingDetailsType
                  <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
                  <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
                  <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
                  <EndTime> dateTime </EndTime>
                  <StartTime> dateTime </StartTime>
                </ListingDetails>
                <ListingType> ListingTypeCodeType </ListingType>
                <PictureDetails> PictureDetailsType </PictureDetails>
                <PrivateNotes> string </PrivateNotes>
                <Quantity> int </Quantity>
                <QuantityAvailable> int </QuantityAvailable>
                <QuestionCount> long </QuestionCount>
                <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch>
                <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
                <SellerProfiles> SellerProfilesType
                  <SellerPaymentProfile> SellerPaymentProfileType
                    <PaymentProfileID> long </PaymentProfileID>
                    <PaymentProfileName> string </PaymentProfileName>
                  </SellerPaymentProfile>
                  <SellerReturnProfile> SellerReturnProfileType
                    <ReturnProfileID> long </ReturnProfileID>
                    <ReturnProfileName> string </ReturnProfileName>
                  </SellerReturnProfile>
                  <SellerShippingProfile> SellerShippingProfileType
                    <ShippingProfileID> long </ShippingProfileID>
                    <ShippingProfileName> string </ShippingProfileName>
                  </SellerShippingProfile>
                </SellerProfiles>
                <SellingStatus> SellingStatusType
                  <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
                  <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
                  <QuantitySold> int </QuantitySold>
                </SellingStatus>
                <ShippingDetails> ShippingDetailsType
                  <GlobalShipping> boolean </GlobalShipping>
                  <ShippingServiceOptions> ShippingServiceOptionsType
                    <LocalPickup> boolean </LocalPickup>
                    <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
                  </ShippingServiceOptions>
                  <!-- ... more ShippingServiceOptions nodes allowed here ... -->
                  <ShippingType> ShippingTypeCodeType </ShippingType>
                </ShippingDetails>
                <SKU> SKUType (string) </SKU>
                <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
                <TimeLeft> duration </TimeLeft>
                <Title> string </Title>
                <Variations> VariationsType
                  <Variation> VariationType
                    <Quantity> int </Quantity>
                    <SellingStatus> SellingStatusType
                      <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
                      <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
                      <QuantitySold> int </QuantitySold>
                    </SellingStatus>
                    <SKU> SKUType (string) </SKU>
                    <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
                    <VariationSpecifics> NameValueListArrayType
                      <NameValueList> NameValueListType
                        <Name> string </Name>
                        <Value> string </Value>
                        <!-- ... more Value values allowed here ... -->
                      </NameValueList>
                      <!-- ... more NameValueList nodes allowed here ... -->
                    </VariationSpecifics>
                    <!-- ... more VariationSpecifics nodes allowed here ... -->
                    <VariationTitle> string </VariationTitle>
                    <WatchCount> long </WatchCount>
                  </Variation>
                  <!-- ... more Variation nodes allowed here ... -->
                </Variations>
                <WatchCount> long </WatchCount>
              </Item>
              <OrderLineItemID> string </OrderLineItemID>
              <PaidTime> dateTime </PaidTime>
              <PaisaPayID> string </PaisaPayID>
              <Platform> TransactionPlatformCodeType </Platform>
              <QuantityPurchased> int </QuantityPurchased>
              <SellerPaidStatus> PaidStatusCodeType </SellerPaidStatus>
              <ShippedTime> dateTime </ShippedTime>
              <Status> TransactionStatusType
                <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
              </Status>
              <TotalPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalPrice>
              <TotalTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalTransactionPrice>
              <TransactionID> string </TransactionID>
            </Transaction>
            <!-- ... more Transaction nodes allowed here ... -->
          </TransactionArray>
        </Order>
        <Transaction> TransactionType
          <Buyer> UserType
            <BuyerInfo> BuyerType
              <ShippingAddress> AddressType
                <PostalCode> string </PostalCode>
              </ShippingAddress>
            </BuyerInfo>
            <Email> string </Email>
            <StaticAlias> string </StaticAlias>
            <UserID> UserIDType (string) </UserID>
          </Buyer>
          <ConvertedTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedTransactionPrice>
          <CreatedDate> dateTime </CreatedDate>
          <FeedbackLeft> FeedbackInfoType
            <CommentType> CommentTypeCodeType </CommentType>
          </FeedbackLeft>
          <FeedbackReceived> FeedbackInfoType
            <CommentType> CommentTypeCodeType </CommentType>
          </FeedbackReceived>
          <IsMultiLegShipping> boolean </IsMultiLegShipping>
          <Item> ItemType
            <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
            <ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
            <HideFromSearch> boolean </HideFromSearch>
            <ItemID> ItemIDType (string) </ItemID>
            <ListingDetails> ListingDetailsType
              <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
              <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
              <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
              <EndTime> dateTime </EndTime>
              <StartTime> dateTime </StartTime>
            </ListingDetails>
            <ListingType> ListingTypeCodeType </ListingType>
            <PictureDetails> PictureDetailsType </PictureDetails>
            <PrivateNotes> string </PrivateNotes>
            <Quantity> int </Quantity>
            <QuantityAvailable> int </QuantityAvailable>
            <QuestionCount> long </QuestionCount>
            <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch>
            <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
            <SellerProfiles> SellerProfilesType
              <SellerPaymentProfile> SellerPaymentProfileType
                <PaymentProfileID> long </PaymentProfileID>
                <PaymentProfileName> string </PaymentProfileName>
              </SellerPaymentProfile>
              <SellerReturnProfile> SellerReturnProfileType
                <ReturnProfileID> long </ReturnProfileID>
                <ReturnProfileName> string </ReturnProfileName>
              </SellerReturnProfile>
              <SellerShippingProfile> SellerShippingProfileType
                <ShippingProfileID> long </ShippingProfileID>
                <ShippingProfileName> string </ShippingProfileName>
              </SellerShippingProfile>
            </SellerProfiles>
            <SellingStatus> SellingStatusType
              <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
              <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
              <QuantitySold> int </QuantitySold>
            </SellingStatus>
            <ShippingDetails> ShippingDetailsType
              <GlobalShipping> boolean </GlobalShipping>
              <ShippingServiceOptions> ShippingServiceOptionsType
                <LocalPickup> boolean </LocalPickup>
                <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
              </ShippingServiceOptions>
              <!-- ... more ShippingServiceOptions nodes allowed here ... -->
              <ShippingType> ShippingTypeCodeType </ShippingType>
            </ShippingDetails>
            <SKU> SKUType (string) </SKU>
            <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
            <TimeLeft> duration </TimeLeft>
            <Title> string </Title>
            <Variations> VariationsType
              <Variation> VariationType
                <Quantity> int </Quantity>
                <SellingStatus> SellingStatusType
                  <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
                  <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
                  <QuantitySold> int </QuantitySold>
                </SellingStatus>
                <SKU> SKUType (string) </SKU>
                <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
                <VariationSpecifics> NameValueListArrayType
                  <NameValueList> NameValueListType
                    <Name> string </Name>
                    <Value> string </Value>
                    <!-- ... more Value values allowed here ... -->
                  </NameValueList>
                  <!-- ... more NameValueList nodes allowed here ... -->
                </VariationSpecifics>
                <!-- ... more VariationSpecifics nodes allowed here ... -->
                <VariationTitle> string </VariationTitle>
                <WatchCount> long </WatchCount>
              </Variation>
              <!-- ... more Variation nodes allowed here ... -->
            </Variations>
            <WatchCount> long </WatchCount>
          </Item>
          <OrderLineItemID> string </OrderLineItemID>
          <PaidTime> dateTime </PaidTime>
          <PaisaPayID> string </PaisaPayID>
          <Platform> TransactionPlatformCodeType </Platform>
          <QuantityPurchased> int </QuantityPurchased>
          <SellerPaidStatus> PaidStatusCodeType </SellerPaidStatus>
          <ShippedTime> dateTime </ShippedTime>
          <Status> TransactionStatusType
            <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
          </Status>
          <TotalPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalPrice>
          <TotalTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalTransactionPrice>
          <TransactionID> string </TransactionID>
        </Transaction>
      </OrderTransaction>
      <!-- ... more OrderTransaction nodes allowed here ... -->
    </OrderTransactionArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </DeletedFromSoldList>
  <DeletedFromUnsoldList> PaginatedItemArrayType
    <ItemArray> ItemArrayType
      <Item> ItemType
        <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
        <ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
        <HideFromSearch> boolean </HideFromSearch>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType
          <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
          <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
          <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
          <EndTime> dateTime </EndTime>
          <StartTime> dateTime </StartTime>
        </ListingDetails>
        <ListingType> ListingTypeCodeType </ListingType>
        <PictureDetails> PictureDetailsType </PictureDetails>
        <PrivateNotes> string </PrivateNotes>
        <Quantity> int </Quantity>
        <QuantityAvailable> int </QuantityAvailable>
        <QuestionCount> long </QuestionCount>
        <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch>
        <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
        <SellerProfiles> SellerProfilesType
          <SellerPaymentProfile> SellerPaymentProfileType
            <PaymentProfileID> long </PaymentProfileID>
            <PaymentProfileName> string </PaymentProfileName>
          </SellerPaymentProfile>
          <SellerReturnProfile> SellerReturnProfileType
            <ReturnProfileID> long </ReturnProfileID>
            <ReturnProfileName> string </ReturnProfileName>
          </SellerReturnProfile>
          <SellerShippingProfile> SellerShippingProfileType
            <ShippingProfileID> long </ShippingProfileID>
            <ShippingProfileName> string </ShippingProfileName>
          </SellerShippingProfile>
        </SellerProfiles>
        <SellingStatus> SellingStatusType
          <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
          <QuantitySold> int </QuantitySold>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType
          <GlobalShipping> boolean </GlobalShipping>
          <ShippingServiceOptions> ShippingServiceOptionsType
            <LocalPickup> boolean </LocalPickup>
            <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          </ShippingServiceOptions>
          <!-- ... more ShippingServiceOptions nodes allowed here ... -->
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <SKU> SKUType (string) </SKU>
        <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
        <TimeLeft> duration </TimeLeft>
        <Title> string </Title>
        <Variations> VariationsType
          <Variation> VariationType
            <PrivateNotes> string </PrivateNotes>
            <Quantity> int </Quantity>
            <SellingStatus> SellingStatusType
              <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
              <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
              <QuantitySold> int </QuantitySold>
            </SellingStatus>
            <SKU> SKUType (string) </SKU>
            <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
            <VariationSpecifics> NameValueListArrayType
              <NameValueList> NameValueListType
                <Name> string </Name>
                <Value> string </Value>
                <!-- ... more Value values allowed here ... -->
              </NameValueList>
              <!-- ... more NameValueList nodes allowed here ... -->
            </VariationSpecifics>
            <!-- ... more VariationSpecifics nodes allowed here ... -->
            <VariationTitle> string </VariationTitle>
            <WatchCount> long </WatchCount>
          </Variation>
          <!-- ... more Variation nodes allowed here ... -->
        </Variations>
        <WatchCount> long </WatchCount>
      </Item>
      <!-- ... more Item nodes allowed here ... -->
    </ItemArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </DeletedFromUnsoldList>
  <ScheduledList> PaginatedItemArrayType
    <ItemArray> ItemArrayType
      <Item> ItemType
        <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
        <ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
        <eBayNotes> string </eBayNotes>
        <HideFromSearch> boolean </HideFromSearch>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType
          <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
          <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
          <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
          <StartTime> dateTime </StartTime>
        </ListingDetails>
        <ListingDuration> token </ListingDuration>
        <ListingType> ListingTypeCodeType </ListingType>
        <PictureDetails> PictureDetailsType </PictureDetails>
        <PrivateNotes> string </PrivateNotes>
        <Quantity> int </Quantity>
        <QuantityAvailable> int </QuantityAvailable>
        <QuestionCount> long </QuestionCount>
        <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch>
        <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
        <SellerProfiles> SellerProfilesType
          <SellerPaymentProfile> SellerPaymentProfileType
            <PaymentProfileID> long </PaymentProfileID>
            <PaymentProfileName> string </PaymentProfileName>
          </SellerPaymentProfile>
          <SellerReturnProfile> SellerReturnProfileType
            <ReturnProfileID> long </ReturnProfileID>
            <ReturnProfileName> string </ReturnProfileName>
          </SellerReturnProfile>
          <SellerShippingProfile> SellerShippingProfileType
            <ShippingProfileID> long </ShippingProfileID>
            <ShippingProfileName> string </ShippingProfileName>
          </SellerShippingProfile>
        </SellerProfiles>
        <SellingStatus> SellingStatusType
          <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
          <QuantitySold> int </QuantitySold>
          <ReserveMet> boolean </ReserveMet>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType
          <GlobalShipping> boolean </GlobalShipping>
          <ShippingServiceOptions> ShippingServiceOptionsType
            <LocalPickup> boolean </LocalPickup>
            <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
            <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
          </ShippingServiceOptions>
          <!-- ... more ShippingServiceOptions nodes allowed here ... -->
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <SKU> SKUType (string) </SKU>
        <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
        <TimeLeft> duration </TimeLeft>
        <Title> string </Title>
        <Variations> VariationsType
          <Variation> VariationType
            <PrivateNotes> string </PrivateNotes>
            <Quantity> int </Quantity>
            <SellingStatus> SellingStatusType
              <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
              <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
              <QuantitySold> int </QuantitySold>
              <ReserveMet> boolean </ReserveMet>
            </SellingStatus>
            <SKU> SKUType (string) </SKU>
            <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
            <VariationSpecifics> NameValueListArrayType
              <NameValueList> NameValueListType
                <Name> string </Name>
                <Value> string </Value>
                <!-- ... more Value values allowed here ... -->
              </NameValueList>
              <!-- ... more NameValueList nodes allowed here ... -->
            </VariationSpecifics>
            <!-- ... more VariationSpecifics nodes allowed here ... -->
            <VariationTitle> string </VariationTitle>
            <WatchCount> long </WatchCount>
          </Variation>
          <!-- ... more Variation nodes allowed here ... -->
        </Variations>
        <WatchCount> long </WatchCount>
      </Item>
      <!-- ... more Item nodes allowed here ... -->
    </ItemArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </ScheduledList>
  <SellingSummary> SellingSummaryType
    <ActiveAuctionCount> int </ActiveAuctionCount>
    <AuctionBidCount> int </AuctionBidCount>
    <AuctionSellingCount> int </AuctionSellingCount>
    <SoldDurationInDays> int </SoldDurationInDays>
    <TotalAuctionSellingValue currencyID="CurrencyCodeType"> AmountType (double) </TotalAuctionSellingValue>
    <TotalSoldCount> int </TotalSoldCount>
    <TotalSoldValue currencyID="CurrencyCodeType"> AmountType (double) </TotalSoldValue>
  </SellingSummary>
  <SoldList> PaginatedOrderTransactionArrayType
    <OrderTransactionArray> OrderTransactionArrayType
      <OrderTransaction> OrderTransactionType
        <Order> OrderType
          <OrderID> OrderIDType (string) </OrderID>
          <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
          <RefundStatus> string </RefundStatus>
          <Subtotal currencyID="CurrencyCodeType"> AmountType (double) </Subtotal>
          <TransactionArray> TransactionArrayType
            <Transaction> TransactionType
              <Buyer> UserType
                <BuyerInfo> BuyerType
                  <ShippingAddress> AddressType
                    <PostalCode> string </PostalCode>
                  </ShippingAddress>
                </BuyerInfo>
                <Email> string </Email>
                <StaticAlias> string </StaticAlias>
                <UserID> UserIDType (string) </UserID>
              </Buyer>
              <ConvertedTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedTransactionPrice>
              <CreatedDate> dateTime </CreatedDate>
              <FeedbackLeft> FeedbackInfoType
                <CommentType> CommentTypeCodeType </CommentType>
              </FeedbackLeft>
              <FeedbackReceived> FeedbackInfoType
                <CommentType> CommentTypeCodeType </CommentType>
              </FeedbackReceived>
              <IsMultiLegShipping> boolean </IsMultiLegShipping>
              <Item> ItemType
                <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
                <ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
                <HideFromSearch> boolean </HideFromSearch>
                <ItemID> ItemIDType (string) </ItemID>
                <ListingDetails> ListingDetailsType
                  <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
                  <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
                  <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
                  <EndTime> dateTime </EndTime>
                  <StartTime> dateTime </StartTime>
                </ListingDetails>
                <ListingType> ListingTypeCodeType </ListingType>
                <PictureDetails> PictureDetailsType </PictureDetails>
                <PrivateNotes> string </PrivateNotes>
                <Quantity> int </Quantity>
                <QuantityAvailable> int </QuantityAvailable>
                <QuestionCount> long </QuestionCount>
                <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch>
                <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
                <SellerProfiles> SellerProfilesType
                  <SellerPaymentProfile> SellerPaymentProfileType
                    <PaymentProfileID> long </PaymentProfileID>
                    <PaymentProfileName> string </PaymentProfileName>
                  </SellerPaymentProfile>
                  <SellerReturnProfile> SellerReturnProfileType
                    <ReturnProfileID> long </ReturnProfileID>
                    <ReturnProfileName> string </ReturnProfileName>
                  </SellerReturnProfile>
                  <SellerShippingProfile> SellerShippingProfileType
                    <ShippingProfileID> long </ShippingProfileID>
                    <ShippingProfileName> string </ShippingProfileName>
                  </SellerShippingProfile>
                </SellerProfiles>
                <SellingStatus> SellingStatusType
                  <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
                  <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
                  <QuantitySold> int </QuantitySold>
                  <ReserveMet> boolean </ReserveMet>
                </SellingStatus>
                <ShippingDetails> ShippingDetailsType
                  <GlobalShipping> boolean </GlobalShipping>
                  <ShippingServiceOptions> ShippingServiceOptionsType
                    <LocalPickup> boolean </LocalPickup>
                    <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
                  </ShippingServiceOptions>
                  <!-- ... more ShippingServiceOptions nodes allowed here ... -->
                  <ShippingType> ShippingTypeCodeType </ShippingType>
                </ShippingDetails>
                <SKU> SKUType (string) </SKU>
                <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
                <TimeLeft> duration </TimeLeft>
                <Title> string </Title>
                <Variations> VariationsType
                  <Variation> VariationType
                    <Quantity> int </Quantity>
                    <SellingStatus> SellingStatusType
                      <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
                      <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
                      <QuantitySold> int </QuantitySold>
                      <ReserveMet> boolean </ReserveMet>
                    </SellingStatus>
                    <SKU> SKUType (string) </SKU>
                    <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
                    <VariationSpecifics> NameValueListArrayType
                      <NameValueList> NameValueListType
                        <Name> string </Name>
                        <Value> string </Value>
                        <!-- ... more Value values allowed here ... -->
                      </NameValueList>
                      <!-- ... more NameValueList nodes allowed here ... -->
                    </VariationSpecifics>
                    <!-- ... more VariationSpecifics nodes allowed here ... -->
                    <VariationTitle> string </VariationTitle>
                    <WatchCount> long </WatchCount>
                  </Variation>
                  <!-- ... more Variation nodes allowed here ... -->
                </Variations>
                <WatchCount> long </WatchCount>
              </Item>
              <OrderLineItemID> string </OrderLineItemID>
              <PaidTime> dateTime </PaidTime>
              <PaisaPayID> string </PaisaPayID>
              <PaymentHoldDetails> PaymentHoldDetailType
                <ExpectedReleaseDate> dateTime </ExpectedReleaseDate>
                <PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason>
                <RequiredSellerActionArray> RequiredSellerActionArrayType
                  <RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction>
                  <!-- ... more RequiredSellerAction values allowed here ... -->
                </RequiredSellerActionArray>
              </PaymentHoldDetails>
              <Platform> TransactionPlatformCodeType </Platform>
              <QuantityPurchased> int </QuantityPurchased>
              <SellerPaidStatus> PaidStatusCodeType </SellerPaidStatus>
              <ShippedTime> dateTime </ShippedTime>
              <Status> TransactionStatusType
                <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
              </Status>
              <TotalPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalPrice>
              <TotalTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalTransactionPrice>
              <TransactionID> string </TransactionID>
            </Transaction>
            <!-- ... more Transaction nodes allowed here ... -->
          </TransactionArray>
        </Order>
        <Transaction> TransactionType
          <Buyer> UserType
            <BuyerInfo> BuyerType
              <ShippingAddress> AddressType
                <PostalCode> string </PostalCode>
              </ShippingAddress>
            </BuyerInfo>
            <Email> string </Email>
            <StaticAlias> string </StaticAlias>
            <UserID> UserIDType (string) </UserID>
          </Buyer>
          <ConvertedTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedTransactionPrice>
          <CreatedDate> dateTime </CreatedDate>
          <FeedbackLeft> FeedbackInfoType
            <CommentType> CommentTypeCodeType </CommentType>
          </FeedbackLeft>
          <FeedbackReceived> FeedbackInfoType
            <CommentType> CommentTypeCodeType </CommentType>
          </FeedbackReceived>
          <IsMultiLegShipping> boolean </IsMultiLegShipping>
          <Item> ItemType
            <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
            <ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
            <HideFromSearch> boolean </HideFromSearch>
            <ItemID> ItemIDType (string) </ItemID>
            <ListingDetails> ListingDetailsType
              <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
              <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
              <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
              <EndTime> dateTime </EndTime>
              <StartTime> dateTime </StartTime>
            </ListingDetails>
            <ListingType> ListingTypeCodeType </ListingType>
            <PictureDetails> PictureDetailsType </PictureDetails>
            <PrivateNotes> string </PrivateNotes>
            <Quantity> int </Quantity>
            <QuantityAvailable> int </QuantityAvailable>
            <QuestionCount> long </QuestionCount>
            <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch>
            <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
            <SellerProfiles> SellerProfilesType
              <SellerPaymentProfile> SellerPaymentProfileType
                <PaymentProfileID> long </PaymentProfileID>
                <PaymentProfileName> string </PaymentProfileName>
              </SellerPaymentProfile>
              <SellerReturnProfile> SellerReturnProfileType
                <ReturnProfileID> long </ReturnProfileID>
                <ReturnProfileName> string </ReturnProfileName>
              </SellerReturnProfile>
              <SellerShippingProfile> SellerShippingProfileType
                <ShippingProfileID> long </ShippingProfileID>
                <ShippingProfileName> string </ShippingProfileName>
              </SellerShippingProfile>
            </SellerProfiles>
            <SellingStatus> SellingStatusType
              <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
              <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
              <QuantitySold> int </QuantitySold>
              <ReserveMet> boolean </ReserveMet>
            </SellingStatus>
            <ShippingDetails> ShippingDetailsType
              <GlobalShipping> boolean </GlobalShipping>
              <ShippingServiceOptions> ShippingServiceOptionsType
                <LocalPickup> boolean </LocalPickup>
                <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
              </ShippingServiceOptions>
              <!-- ... more ShippingServiceOptions nodes allowed here ... -->
              <ShippingType> ShippingTypeCodeType </ShippingType>
            </ShippingDetails>
            <SKU> SKUType (string) </SKU>
            <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
            <TimeLeft> duration </TimeLeft>
            <Title> string </Title>
            <Variations> VariationsType
              <Variation> VariationType
                <Quantity> int </Quantity>
                <SellingStatus> SellingStatusType
                  <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
                  <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
                  <QuantitySold> int </QuantitySold>
                  <ReserveMet> boolean </ReserveMet>
                </SellingStatus>
                <SKU> SKUType (string) </SKU>
                <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
                <VariationSpecifics> NameValueListArrayType
                  <NameValueList> NameValueListType
                    <Name> string </Name>
                    <Value> string </Value>
                    <!-- ... more Value values allowed here ... -->
                  </NameValueList>
                  <!-- ... more NameValueList nodes allowed here ... -->
                </VariationSpecifics>
                <!-- ... more VariationSpecifics nodes allowed here ... -->
                <VariationTitle> string </VariationTitle>
                <WatchCount> long </WatchCount>
              </Variation>
              <!-- ... more Variation nodes allowed here ... -->
            </Variations>
            <WatchCount> long </WatchCount>
          </Item>
          <OrderLineItemID> string </OrderLineItemID>
          <PaidTime> dateTime </PaidTime>
          <PaisaPayID> string </PaisaPayID>
          <PaymentHoldDetails> PaymentHoldDetailType
            <ExpectedReleaseDate> dateTime </ExpectedReleaseDate>
            <PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason>
            <RequiredSellerActionArray> RequiredSellerActionArrayType
              <RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction>
              <!-- ... more RequiredSellerAction values allowed here ... -->
            </RequiredSellerActionArray>
          </PaymentHoldDetails>
          <Platform> TransactionPlatformCodeType </Platform>
          <QuantityPurchased> int </QuantityPurchased>
          <SellerPaidStatus> PaidStatusCodeType </SellerPaidStatus>
          <ShippedTime> dateTime </ShippedTime>
          <Status> TransactionStatusType
            <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
          </Status>
          <TotalPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalPrice>
          <TotalTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalTransactionPrice>
          <TransactionID> string </TransactionID>
        </Transaction>
      </OrderTransaction>
      <!-- ... more OrderTransaction nodes allowed here ... -->
    </OrderTransactionArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </SoldList>
  <Summary> MyeBaySellingSummaryType
    <ActiveAuctionCount> int </ActiveAuctionCount>
    <AmountLimitRemaining currencyID="CurrencyCodeType"> AmountType (double) </AmountLimitRemaining>
    <AuctionBidCount> int </AuctionBidCount>
    <AuctionSellingCount> int </AuctionSellingCount>
    <ClassifiedAdCount> int </ClassifiedAdCount>
    <ClassifiedAdOfferCount> int </ClassifiedAdOfferCount>
    <QuantityLimitRemaining> long </QuantityLimitRemaining>
    <SoldDurationInDays> int </SoldDurationInDays>
    <TotalAuctionSellingValue currencyID="CurrencyCodeType"> AmountType (double) </TotalAuctionSellingValue>
    <TotalLeadCount> int </TotalLeadCount>
    <TotalListingsWithLeads> int </TotalListingsWithLeads>
    <TotalSoldCount> int </TotalSoldCount>
    <TotalSoldValue currencyID="CurrencyCodeType"> AmountType (double) </TotalSoldValue>
  </Summary>
  <UnsoldList> PaginatedItemArrayType
    <ItemArray> ItemArrayType
      <Item> ItemType
        <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
        <ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
        <eBayNotes> string </eBayNotes>
        <HideFromSearch> boolean </HideFromSearch>
        <ItemID> ItemIDType (string) </ItemID>
        <LeadCount> int </LeadCount>
        <ListingDetails> ListingDetailsType
          <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
          <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
          <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
          <EndTime> dateTime </EndTime>
          <StartTime> dateTime </StartTime>
        </ListingDetails>
        <ListingDuration> token </ListingDuration>
        <ListingType> ListingTypeCodeType </ListingType>
        <PictureDetails> PictureDetailsType </PictureDetails>
        <PrivateNotes> string </PrivateNotes>
        <Quantity> int </Quantity>
        <QuantityAvailable> int </QuantityAvailable>
        <QuestionCount> long </QuestionCount>
        <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch>
        <Relisted> boolean </Relisted>
        <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
        <SellerProfiles> SellerProfilesType
          <SellerPaymentProfile> SellerPaymentProfileType
            <PaymentProfileID> long </PaymentProfileID>
            <PaymentProfileName> string </PaymentProfileName>
          </SellerPaymentProfile>
          <SellerReturnProfile> SellerReturnProfileType
            <ReturnProfileID> long </ReturnProfileID>
            <ReturnProfileName> string </ReturnProfileName>
          </SellerReturnProfile>
          <SellerShippingProfile> SellerShippingProfileType
            <ShippingProfileID> long </ShippingProfileID>
            <ShippingProfileName> string </ShippingProfileName>
          </SellerShippingProfile>
        </SellerProfiles>
        <SellingStatus> SellingStatusType
          <BidCount> int </BidCount>
          <BidderCount> long </BidderCount>
          <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
          <QuantitySold> int </QuantitySold>
          <ReserveMet> boolean </ReserveMet>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType
          <GlobalShipping> boolean </GlobalShipping>
          <ShippingServiceOptions> ShippingServiceOptionsType
            <LocalPickup> boolean </LocalPickup>
            <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          </ShippingServiceOptions>
          <!-- ... more ShippingServiceOptions nodes allowed here ... -->
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <SKU> SKUType (string) </SKU>
        <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
        <TimeLeft> duration </TimeLeft>
        <Title> string </Title>
        <Variations> VariationsType
          <Variation> VariationType
            <PrivateNotes> string </PrivateNotes>
            <Quantity> int </Quantity>
            <SellingStatus> SellingStatusType
              <BidCount> int </BidCount>
              <BidderCount> long </BidderCount>
              <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
              <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
              <QuantitySold> int </QuantitySold>
              <ReserveMet> boolean </ReserveMet>
            </SellingStatus>
            <SKU> SKUType (string) </SKU>
            <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
            <VariationSpecifics> NameValueListArrayType
              <NameValueList> NameValueListType
                <Name> string </Name>
                <Value> string </Value>
                <!-- ... more Value values allowed here ... -->
              </NameValueList>
              <!-- ... more NameValueList nodes allowed here ... -->
            </VariationSpecifics>
            <!-- ... more VariationSpecifics nodes allowed here ... -->
            <VariationTitle> string </VariationTitle>
            <WatchCount> long </WatchCount>
          </Variation>
          <!-- ... more Variation nodes allowed here ... -->
        </Variations>
        <WatchCount> long </WatchCount>
      </Item>
      <!-- ... more Item nodes allowed here ... -->
    </ItemArray>
    <PaginationResult> PaginationResultType
      <TotalNumberOfEntries> int </TotalNumberOfEntries>
      <TotalNumberOfPages> int </TotalNumberOfPages>
    </PaginationResult>
  </UnsoldList>
  <!-- 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>
</GetMyeBaySellingResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
ActiveList PaginatedItemArrayType Conditionally This container consists of active listings. This container will be returned if the eBay user has one or more active listings on eBay.com.

This container will not be returned in the response (even if there are one or more active listings) if the DetailLevel value is set to ReturnSummary and the ActiveList.Include field is omitted or set to false.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray ItemArrayType Conditionally Contains a list of Item types.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.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.
ActiveList.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.
ActiveList.ItemArray.Item
  .BestOfferDetails
  .BestOfferCount
int Conditionally The number of Best Offers made for this item, if any. In other words, if there are no Best Offers made, this field will not appear in the response. This field is not applicable to the Add/Revise/Relist calls.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.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.
ActiveList.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.
ActiveList.ItemArray.Item
  .ClassifiedAdPayPerLeadFee
AmountType (double) Conditionally The email and phone lead fee for a pay-per-lead item.

DetailLevel: ReturnAll.
ActiveList.ItemArray.Item
  .ClassifiedAdPayPerLeadFee
  [ attribute currencyID ]
CurrencyCodeType Conditionally The email and phone lead fee for a pay-per-lead item.

For a list of possible enumeration values, see CurrencyCodeType.
ActiveList.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.
ActiveList.ItemArray.Item
  .HideFromSearch
boolean Conditionally This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
ActiveList.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.
ActiveList.ItemArray.Item
  .LeadCount
int Conditionally Specifies the number of leads (emails) buyers have posted about the item. You must be the seller of the item to retrieve the lead count.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.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.
ActiveList.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.
ActiveList.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.
ActiveList.ItemArray.Item
  .ListingDetails
  .ConvertedReservePrice
AmountType (double) Conditionally Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .ListingDetails
  .ConvertedReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price listings.

For a list of possible enumeration values, see CurrencyCodeType.
ActiveList.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.
ActiveList.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.
ActiveList.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.
ActiveList.ItemArray.Item
  .ListingDuration
token Conditionally Describes the number of days the seller wants the listing to be active (available for bidding/buying). The duration specifies the seller's initial intent at listing time.

The end time for a listing is calculated by adding the duration to the item's start time. If the listing ends early, the value of the listing duration does not change. When a listing's duration is changed, any related fees (e.g., 10-day fee) may be debited or credited (as applicable).

The valid choice of values depends on the listing format (see Item.ListingType). For a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll and look for ListingDurations information.

When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours.

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

See:
    GetCategoryFeatures
    Fees per Site



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

ActiveList.ItemArray.Item
  .NewLeadCount
int Conditionally Specifies the number of new leads (unanswered emails) buyers have posted about the item.

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

ActiveList.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).
ActiveList.ItemArray.Item
  .Quantity
int Conditionally For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations.

For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1.

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

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

For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1.

For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value.

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

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
    Selecting a Selling Format

ActiveList.ItemArray.Item
  .QuantityAvailable
int Conditionally This integer value indicates the quantity of an item that is still available for purchase in a multiple-quantity, fixed-price listing. This field is not applicable to auction listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .QuestionCount
long Conditionally Specifies the number of questions buyers have posted about the item. Returned only if greater than 0.
ActiveList.ItemArray.Item
  .ReasonHideFromSearch
ReasonHideFromSearchCodeType Conditionally This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.

Applicable values:

DuplicateListing
(out) This value indicates that the auction listing is being hidden from search on the eBay site because the listing has been determined by eBay to be a duplicate listing with zero bids.

This enumeration is associated with eBay Duplicate Listings Policy, which has taken effect on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read eBay's Duplicate Listings Policy help page.
OutOfStock
(out) This value indicates that the listing is hidden from search because the quantity is zero. However, the listing is still alive and will reappear in the search results when the quantity is set to something greater than zero. For more information, see SetUserPreferences.OutOfStockControlPreference.

Code so that your app gracefully handles any future changes to this list.
ActiveList.ItemArray.Item
  .ReservePrice
AmountType (double) Conditionally The lowest price at which the seller is willing to sell an auction item. (StartPrice must be lower than ReservePrice .) Not all categories support a Reserve Price. Use GetCategories to see if a category supports a Reserve Price. In calls that retrieve item data, the ReservePrice field will only be returned to the auction item's seller, and only if a Reserve Price has been set up. A Reserve Price is not applicable to fixed-price or classified ad listings.

You can remove the Reserve price of a US eBay Motors listing if the category allows it, the current Reserve Price has not been met, and the Reserve Price is at least $2.00 more than the current high bid. In this case, if the item has bids, the Reserve Price is set to $1.00 over the current high bid. The next bid meets the Reserve Price and wins. See Fees Overview below for information about fee credits that may be available when the Reserve Price is removed for a Motors listing.

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

See:
    Revising Items
    Reserve Price (eBay site help)
    Fees Overview (eBay site help)
    Determining Whether a Category Supports Reserve Prices

ActiveList.ItemArray.Item
  .ReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The lowest price at which the seller is willing to sell an auction item. (StartPrice must be lower than ReservePrice .) Not all categories support a Reserve Price. Use GetCategories to see if a category supports a Reserve Price. In calls that retrieve item data, the ReservePrice field will only be returned to the auction item's seller, and only if a Reserve Price has been set up. A Reserve Price is not applicable to fixed-price or classified ad listings.

You can remove the Reserve price of a US eBay Motors listing if the category allows it, the current Reserve Price has not been met, and the Reserve Price is at least $2.00 more than the current high bid. In this case, if the item has bids, the Reserve Price is set to $1.00 over the current high bid. The next bid meets the Reserve Price and wins. See Fees Overview below for information about fee credits that may be available when the Reserve Price is removed for a Motors listing.

For a list of possible enumeration values, see CurrencyCodeType.
ActiveList.ItemArray.Item
  .SellerProfiles
SellerProfilesType Conditionally This container is used if the seller would like to use/reference Business Policies to create, revise, relist, or verify their listing. The seller's account must be opted in to Business Policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy is applied to the listing. If the seller's account is not opted in to Business Policies, that seller may not use this container. Sellers must opt-in to Business Policies through My eBay or by using the optInToProgram call of the eBay Account API.

If Business Policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
ActiveList.ItemArray.Item
  .SellerProfiles
  .SellerPaymentProfile
SellerPaymentProfileType Conditionally The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
ActiveList.ItemArray.Item
  .SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileID
long Conditionally The unique identifier of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

Payment profile IDs can be retrieved with the getPaymentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

In the 'Get' calls, the PaymentProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment profile.
ActiveList.ItemArray.Item
  .SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileName
string Conditionally The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

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

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
ActiveList.ItemArray.Item
  .SellerProfiles
  .SellerReturnProfile
  .ReturnProfileID
long Conditionally The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

Return Policy profile IDs can be retrieved with the getReturnPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

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

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

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
ActiveList.ItemArray.Item
  .SellerProfiles
  .SellerShippingProfile
  .ShippingProfileID
long Conditionally The unique identifier of a Business Policies shipping profile. A ShippingProfileID and/or a ShipppingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the Shippping values of a Business Policies shipping profile. If both fields are provided and their values don't match, the ShipppingProfileID takes precedence.

Shipping profile IDs can be retrieved with the getFulfillmentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

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

In the 'Get' calls, the ShippingProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the payment profile.
ActiveList.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.
ActiveList.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.
ActiveList.ItemArray.Item
  .SellingStatus.BidderCount
long Conditionally Number of bidders for an item. Only applicable to auction listings. Only returned for the seller of the item.

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

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

ActiveList.ItemArray.Item
  .SellingStatus
  .PromotionalSaleDetails
PromotionalSaleDetailsType Conditionally If a seller has reduced the price of a listed item with the Promotional Price Display feature, this field contains the original price of the discounted item, along with the start-time and end-time of the discount.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .SellingStatus
  .PromotionalSaleDetails
  .EndTime
dateTime Conditionally End time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .SellingStatus
  .PromotionalSaleDetails
  .OriginalPrice
AmountType (double) Conditionally Original price of an item whose price a seller has reduced with the Promotional Price Display feature.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .SellingStatus
  .PromotionalSaleDetails
  .OriginalPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Original price of an item whose price a seller has reduced with the Promotional Price Display feature.

For a list of possible enumeration values, see CurrencyCodeType.
ActiveList.ItemArray.Item
  .SellingStatus
  .PromotionalSaleDetails
  .StartTime
dateTime Conditionally Start time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .SellingStatus.QuantitySold
int Conditionally The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

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

In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item.

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

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

ActiveList.ItemArray.Item
  .ShippingDetails
  .GlobalShipping
boolean Conditionally Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, international shipping through the Global Shipping Program is available for the listing, and eBay automatically sets one of the available shipping service options to International Priority Shipping. If the value of GlobalShipping is false, the seller is responsible for specifying one or more international shipping service options if the seller is willing to ship internationally.

When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change.

Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program.

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

See Introduction to Shipping for information about Global Shipping Program eligibility.

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

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


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

See Determining Shipping Costs for a Listing.

ActiveList.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.
ActiveList.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.
ActiveList.ItemArray.Item.SKU SKUType (string) Conditionally A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus

A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.)

If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

For multiple-variation listings, a SKU value is actually required for each product variation within the listing. However, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request.

Note: The eBay site cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.)

For GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing.

Max length: 50.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

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

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

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

ActiveList.ItemArray.Item
  .Variations.Variation
  .PrivateNotes
string Conditionally A note a user makes on an item with variations in My eBay.

For eBay.com, only GetMyeBaySelling (not GetItem) returns this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note.

Not supported as input in ReviseFixedPriceItem. Use SetUserNotes instead.

In SoldList, notes for variations are only returned at the Item level, not the variation level.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .Variations.Variation.Quantity
int Conditionally This value indicates the quantity of items in the specific variation that are available for purchase. If you set Variation.Quantity to 0 when you create, revise, or relist an item listing, the variation is dropped from the listing. To prevent this, you can set SetUserPreferences.OutOfStockControlPreference to true.

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

For RelistFixedPriceItem:
  • For an item variation that had an available quantity greater than 0 when the listing ended, the Quantity value of the item variation for the newly relisted item is set to the actual quantity available. For item variations, there is actually no QuantityAvailable field, but this value may be derived if you look at the corresponding item variation in a GetMyeBaySelling) response and subtract the Variation.QuantitySold value from the Variation.Quantity value, which represents the original Variation.Quantity value at creation time of the previous listing.
  • For item variations with an available quantity of 0 when the listing ended, the relisted item will retain the Variaton.Quantity value that was passed in at creation time of the previous listing.
So, if you are relisting an item that had one or more item variations with an available quantity of 0 when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding Variation.Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value, while also making sure to pass in the correct SKU value(s) to identify the correct item variation. A ReviseInventoryStatus call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings).

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

For GetSellerTransactions: See Item.Quantityinstead.

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

Note: The number in the Variation.Quantity field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup, eBay Now, or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to 0, and the Item.IgnoreQuantity will also be returned as True.


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

See:
    Describing Variations in a Listing
    Using the Out-of-Stock Feature for more details

ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus
SellingStatusType Conditionally Contains the variation's quantity sold. Always returned when variations are present.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus.BidCount
int Conditionally Number of bids placed so far against the auction item.
ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus.BidderCount
long Conditionally Number of bidders for an item. Only applicable to auction listings. Only returned for the seller of the item.
ActiveList.ItemArray.Item
  .Variations.Variation
  .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.
ActiveList.ItemArray.Item
  .Variations.Variation
  .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.
ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus.CurrentPrice
AmountType (double) Conditionally The current price of the item in the original listing currency.

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

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

In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale.
ActiveList.ItemArray.Item
  .Variations.Variation
  .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.
ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus.HighBidder
UserType Conditionally For ended auction listings that have a winning bidder, this field is a container for the high bidder's user ID. For ended, single-item, fixed-price listings, this field is a container for the user ID of the purchaser. This field isn't returned for auctions with no bids, or for active fixed-price listings.

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).
ActiveList.ItemArray.Item
  .Variations.Variation
  .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.
ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus.HighBidder
  .FeedbackScore
int Conditionally The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in either side of an order.

Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site).

If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned.

GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling.

Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned.

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.

ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus.HighBidder
  .UserID
UserIDType (string) Conditionally Unique eBay user ID for the user.

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

When bidding on items, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A".

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.

ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus
  .PromotionalSaleDetails
PromotionalSaleDetailsType Conditionally If a seller has reduced the price of a listed item with the Promotional Price Display feature, this field contains the original price of the discounted item, along with the start-time and end-time of the discount.
ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus
  .PromotionalSaleDetails
  .EndTime
dateTime Conditionally End time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus
  .PromotionalSaleDetails
  .OriginalPrice
AmountType (double) Conditionally Original price of an item whose price a seller has reduced with the Promotional Price Display feature.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus
  .PromotionalSaleDetails
  .OriginalPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Original price of an item whose price a seller has reduced with the Promotional Price Display feature.

For a list of possible enumeration values, see CurrencyCodeType.
ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus
  .PromotionalSaleDetails
  .StartTime
dateTime Conditionally Start time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .Variations.Variation
  .SellingStatus.QuantitySold
int Conditionally The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

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

In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item.

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

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

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

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

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

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

See Describing Variations in a Listing.

ActiveList.ItemArray.Item
  .Variations.Variation
  .StartPrice
AmountType (double) Conditionally The fixed price for this item variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

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

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

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

See Describing Variations in a Listing.

ActiveList.ItemArray.Item
  .Variations.Variation
  .StartPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The fixed price for this item variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

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

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

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

ActiveList.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.
ActiveList.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.
ActiveList.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.
ActiveList.ItemArray.Item
  .Variations.Variation
  .VariationTitle
string Conditionally The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify item variations(for buyers and sellers).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .Variations.Variation
  .WatchCount
long Conditionally The number of watches placed on this variation by eBay users.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ActiveList.ItemArray.Item
  .WatchCount
long Conditionally The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0.
ActiveList.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.
ActiveList.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.
ActiveList.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.
DeletedFromSoldList PaginatedOrderTransactionArrayType Conditionally This container consists of listings that have had sales but have been deleted from My eBay. This container will be returned if the eBay user has one or more listings with sales that have been deleted from My eBay.

This container will not be returned in the response (even if there are one or more listings that have sales but have been deleted) if the DetailLevel value is set to ReturnSummary and the DeletedFromSoldList.Include field is omitted or set to false.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
OrderTransactionArrayType Conditionally Contains the list of orders.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
OrderType Conditionally Contains the information describing an order.

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

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

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

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Buyer
UserType Conditionally Container consisting of user and shipping details for the buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if Seller is making the request.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container 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, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
BuyerType Conditionally Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

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

See Working with Anonymous User Information.

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
AddressType Conditionally This container uses AddressType, and each call that uses BuyerType uses the ShippingAddress container a little differently. See the Call Reference documentation for each call to see what fields of AddressType are used by each call. Output only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.PostalCode
string Conditionally User's postal code.

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Max length: 24.

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

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Buyer.StaticAlias
string Conditionally Contains the static email address of an eBay member, used within the "reply to" email address when the eBay member sends a message. (Each eBay member is assigned a static alias. The alias is used within a static email address.)

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

See Static Email Addresses in Trading API Calls.

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

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .ConvertedTransactionPrice
AmountType (double) Conditionally Converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .ConvertedTransactionPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .IsMultiLegShipping
boolean Conditionally If IsMultilegShipping is true, the Global Shipping Program (GSP) will be used to ship the order line item to an international buyer. A GSP shipment has a domestic leg and an international leg. The buyer's shipping address is in a country other than the country where the item was listed, and the seller has specified 'InternationalPriorityShipping' as the default international shipping service in the listing.

If IsMultilegShipping is false, the order line item will not be shipped with the Global Shipping Program.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item
  .ClassifiedAdPayPerLeadFee
AmountType (double) Conditionally The email and phone lead fee for a pay-per-lead item.

DetailLevel: ReturnAll.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item
  .ClassifiedAdPayPerLeadFee
  [ attribute currencyID ]
CurrencyCodeType Conditionally The email and phone lead fee for a pay-per-lead item.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.HideFromSearch
boolean Conditionally This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ListingDetails
  .ConvertedReservePrice
AmountType (double) Conditionally Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ListingDetails
  .ConvertedReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price listings.

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

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

DeletedFromSoldList
  .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).
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Quantity
int Conditionally For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations.

For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1.

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

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

For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1.

For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value.

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

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
    Selecting a Selling Format

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.QuantityAvailable
int Conditionally This integer value indicates the quantity of an item that is still available for purchase in a multiple-quantity, fixed-price listing. This field is not applicable to auction listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.QuestionCount
long Conditionally Specifies the number of questions buyers have posted about the item. Returned only if greater than 0.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ReasonHideFromSearch
ReasonHideFromSearchCodeType Conditionally This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.

Applicable values:

DuplicateListing
(out) This value indicates that the auction listing is being hidden from search on the eBay site because the listing has been determined by eBay to be a duplicate listing with zero bids.

This enumeration is associated with eBay Duplicate Listings Policy, which has taken effect on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read eBay's Duplicate Listings Policy help page.
OutOfStock
(out) This value indicates that the listing is hidden from search because the quantity is zero. However, the listing is still alive and will reappear in the search results when the quantity is set to something greater than zero. For more information, see SetUserPreferences.OutOfStockControlPreference.

Code so that your app gracefully handles any future changes to this list.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ReservePrice
AmountType (double) Conditionally The lowest price at which the seller is willing to sell an auction item. (StartPrice must be lower than ReservePrice .) Not all categories support a Reserve Price. Use GetCategories to see if a category supports a Reserve Price. In calls that retrieve item data, the ReservePrice field will only be returned to the auction item's seller, and only if a Reserve Price has been set up. A Reserve Price is not applicable to fixed-price or classified ad listings.

You can remove the Reserve price of a US eBay Motors listing if the category allows it, the current Reserve Price has not been met, and the Reserve Price is at least $2.00 more than the current high bid. In this case, if the item has bids, the Reserve Price is set to $1.00 over the current high bid. The next bid meets the Reserve Price and wins. See Fees Overview below for information about fee credits that may be available when the Reserve Price is removed for a Motors listing.

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

See:
    Revising Items
    Reserve Price (eBay site help)
    Fees Overview (eBay site help)
    Determining Whether a Category Supports Reserve Prices

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The lowest price at which the seller is willing to sell an auction item. (StartPrice must be lower than ReservePrice .) Not all categories support a Reserve Price. Use GetCategories to see if a category supports a Reserve Price. In calls that retrieve item data, the ReservePrice field will only be returned to the auction item's seller, and only if a Reserve Price has been set up. A Reserve Price is not applicable to fixed-price or classified ad listings.

You can remove the Reserve price of a US eBay Motors listing if the category allows it, the current Reserve Price has not been met, and the Reserve Price is at least $2.00 more than the current high bid. In this case, if the item has bids, the Reserve Price is set to $1.00 over the current high bid. The next bid meets the Reserve Price and wins. See Fees Overview below for information about fee credits that may be available when the Reserve Price is removed for a Motors listing.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellerProfiles
SellerProfilesType Conditionally This container is used if the seller would like to use/reference Business Policies to create, revise, relist, or verify their listing. The seller's account must be opted in to Business Policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy is applied to the listing. If the seller's account is not opted in to Business Policies, that seller may not use this container. Sellers must opt-in to Business Policies through My eBay or by using the optInToProgram call of the eBay Account API.

If Business Policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellerProfiles
  .SellerPaymentProfile
SellerPaymentProfileType Conditionally The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileID
long Conditionally The unique identifier of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

Payment profile IDs can be retrieved with the getPaymentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

In the 'Get' calls, the PaymentProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment profile.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileName
string Conditionally The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

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

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellerProfiles
  .SellerReturnProfile
  .ReturnProfileID
long Conditionally The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

Return Policy profile IDs can be retrieved with the getReturnPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

In the 'Get' calls, the ReturnProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy profile.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellerProfiles
  .SellerReturnProfile
  .ReturnProfileName
string Conditionally The name of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

In the 'Get' calls, the ReturnProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy profile.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellerProfiles
  .SellerShippingProfile
SellerShippingProfileType Conditionally The SellerShippingProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the values of a Business Policies shipping policy profile. Business Policies shipping profiles contain detailed information on domestic and international shipping, including shipping service options, handling time, package handling costs, excluded ship-to locations, and shipping insurance information.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileID
long Conditionally The unique identifier of a Business Policies shipping profile. A ShippingProfileID and/or a ShipppingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the Shippping values of a Business Policies shipping profile. If both fields are provided and their values don't match, the ShipppingProfileID takes precedence.

Shipping profile IDs can be retrieved with the getFulfillmentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

In the 'Get' calls, the ShipppingProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ShipppingProfileName value will be returned if a name is assigned to the shipping profile.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileName
string Conditionally The name of a Business Policies shipping profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shipping values of a Business Policies shipping profile. If both fields are provided and their values don't match, the ShippingProfileID takes precedence.

In the 'Get' calls, the ShippingProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the payment profile.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SellingStatus
  .QuantitySold
int Conditionally The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

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

In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item.

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

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

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.ShippingDetails
  .GlobalShipping
boolean Conditionally Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, international shipping through the Global Shipping Program is available for the listing, and eBay automatically sets one of the available shipping service options to International Priority Shipping. If the value of GlobalShipping is false, the seller is responsible for specifying one or more international shipping service options if the seller is willing to ship internationally.

When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change.

Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program.

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

See Introduction to Shipping for information about Global Shipping Program eligibility.

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

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


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

See Determining Shipping Costs for a Listing.

DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.SKU
SKUType (string) Conditionally A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus

A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.)

If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

For multiple-variation listings, a SKU value is actually required for each product variation within the listing. However, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request.

Note: The eBay site cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.)

For GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing.

Max length: 50.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

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

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

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

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Variations.Variation
  .Quantity
int Conditionally This value indicates the quantity of items in the specific variation that are available for purchase. If you set Variation.Quantity to 0 when you create, revise, or relist an item listing, the variation is dropped from the listing. To prevent this, you can set SetUserPreferences.OutOfStockControlPreference to true.

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

For RelistFixedPriceItem:
  • For an item variation that had an available quantity greater than 0 when the listing ended, the Quantity value of the item variation for the newly relisted item is set to the actual quantity available. For item variations, there is actually no QuantityAvailable field, but this value may be derived if you look at the corresponding item variation in a GetMyeBaySelling) response and subtract the Variation.QuantitySold value from the Variation.Quantity value, which represents the original Variation.Quantity value at creation time of the previous listing.
  • For item variations with an available quantity of 0 when the listing ended, the relisted item will retain the Variaton.Quantity value that was passed in at creation time of the previous listing.
So, if you are relisting an item that had one or more item variations with an available quantity of 0 when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding Variation.Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value, while also making sure to pass in the correct SKU value(s) to identify the correct item variation. A ReviseInventoryStatus call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings).

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

For GetSellerTransactions: See Item.Quantityinstead.

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

Note: The number in the Variation.Quantity field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup, eBay Now, or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to 0, and the Item.IgnoreQuantity will also be returned as True.


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

See:
    Describing Variations in a Listing
    Using the Out-of-Stock Feature for more details

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Variations.Variation
  .SellingStatus
SellingStatusType Conditionally Contains the variation's quantity sold. Always returned when variations are present.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Variations.Variation
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Variations.Variation
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Variations.Variation
  .SellingStatus.CurrentPrice
AmountType (double) Conditionally The current price of the item in the original listing currency.

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

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

In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Variations.Variation
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Variations.Variation
  .SellingStatus.QuantitySold
int Conditionally The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

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

In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item.

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

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

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

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

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

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

See Describing Variations in a Listing.

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Variations.Variation
  .StartPrice
AmountType (double) Conditionally The fixed price for this item variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

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

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

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

See Describing Variations in a Listing.

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Variations.Variation
  .StartPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The fixed price for this item variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

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

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

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

DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Variations.Variation
  .VariationTitle
string Conditionally The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify item variations(for buyers and sellers).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.Variations.Variation
  .WatchCount
long Conditionally The number of watches placed on this variation by eBay users.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .Item.WatchCount
long Conditionally The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Order
  .TransactionArray.Transaction
  .SellerPaidStatus
PaidStatusCodeType Conditionally Specifies the paid status of the order.

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

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

DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
TransactionType Conditionally Contains the information describing a transaction.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Buyer
UserType Conditionally Container consisting of user and shipping details for the buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if Seller is making the request.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container 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, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Buyer.BuyerInfo
BuyerType Conditionally Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

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

See Working with Anonymous User Information.

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
AddressType Conditionally This container uses AddressType, and each call that uses BuyerType uses the ShippingAddress container a little differently. See the Call Reference documentation for each call to see what fields of AddressType are used by each call. Output only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.PostalCode
string Conditionally User's postal code.

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Max length: 24.

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

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Buyer.StaticAlias
string Conditionally Contains the static email address of an eBay member, used within the "reply to" email address when the eBay member sends a message. (Each eBay member is assigned a static alias. The alias is used within a static email address.)

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

See Static Email Addresses in Trading API Calls.

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

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .ConvertedTransactionPrice
AmountType (double) Conditionally Converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .ConvertedTransactionPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .IsMultiLegShipping
boolean Conditionally If IsMultilegShipping is true, the Global Shipping Program (GSP) will be used to ship the order line item to an international buyer. A GSP shipment has a domestic leg and an international leg. The buyer's shipping address is in a country other than the country where the item was listed, and the seller has specified 'InternationalPriorityShipping' as the default international shipping service in the listing.

If IsMultilegShipping is false, the order line item will not be shipped with the Global Shipping Program.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item
  .ClassifiedAdPayPerLeadFee
AmountType (double) Conditionally The email and phone lead fee for a pay-per-lead item.

DetailLevel: ReturnAll.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item
  .ClassifiedAdPayPerLeadFee
  [ attribute currencyID ]
CurrencyCodeType Conditionally The email and phone lead fee for a pay-per-lead item.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.HideFromSearch
boolean Conditionally This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ListingDetails
  .ConvertedReservePrice
AmountType (double) Conditionally Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ListingDetails
  .ConvertedReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price listings.

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

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

DeletedFromSoldList
  .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).
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Quantity
int Conditionally For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations.

For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1.

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

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

For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1.

For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value.

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

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
    Selecting a Selling Format

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.QuantityAvailable
int Conditionally This integer value indicates the quantity of an item that is still available for purchase in a multiple-quantity, fixed-price listing. This field is not applicable to auction listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.QuestionCount
long Conditionally Specifies the number of questions buyers have posted about the item. Returned only if greater than 0.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ReasonHideFromSearch
ReasonHideFromSearchCodeType Conditionally This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.

Applicable values:

DuplicateListing
(out) This value indicates that the auction listing is being hidden from search on the eBay site because the listing has been determined by eBay to be a duplicate listing with zero bids.

This enumeration is associated with eBay Duplicate Listings Policy, which has taken effect on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read eBay's Duplicate Listings Policy help page.
OutOfStock
(out) This value indicates that the listing is hidden from search because the quantity is zero. However, the listing is still alive and will reappear in the search results when the quantity is set to something greater than zero. For more information, see SetUserPreferences.OutOfStockControlPreference.

Code so that your app gracefully handles any future changes to this list.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ReservePrice
AmountType (double) Conditionally The lowest price at which the seller is willing to sell an auction item. (StartPrice must be lower than ReservePrice .) Not all categories support a Reserve Price. Use GetCategories to see if a category supports a Reserve Price. In calls that retrieve item data, the ReservePrice field will only be returned to the auction item's seller, and only if a Reserve Price has been set up. A Reserve Price is not applicable to fixed-price or classified ad listings.

You can remove the Reserve price of a US eBay Motors listing if the category allows it, the current Reserve Price has not been met, and the Reserve Price is at least $2.00 more than the current high bid. In this case, if the item has bids, the Reserve Price is set to $1.00 over the current high bid. The next bid meets the Reserve Price and wins. See Fees Overview below for information about fee credits that may be available when the Reserve Price is removed for a Motors listing.

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

See:
    Revising Items
    Reserve Price (eBay site help)
    Fees Overview (eBay site help)
    Determining Whether a Category Supports Reserve Prices

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The lowest price at which the seller is willing to sell an auction item. (StartPrice must be lower than ReservePrice .) Not all categories support a Reserve Price. Use GetCategories to see if a category supports a Reserve Price. In calls that retrieve item data, the ReservePrice field will only be returned to the auction item's seller, and only if a Reserve Price has been set up. A Reserve Price is not applicable to fixed-price or classified ad listings.

You can remove the Reserve price of a US eBay Motors listing if the category allows it, the current Reserve Price has not been met, and the Reserve Price is at least $2.00 more than the current high bid. In this case, if the item has bids, the Reserve Price is set to $1.00 over the current high bid. The next bid meets the Reserve Price and wins. See Fees Overview below for information about fee credits that may be available when the Reserve Price is removed for a Motors listing.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SellerProfiles
SellerProfilesType Conditionally This container is used if the seller would like to use/reference Business Policies to create, revise, relist, or verify their listing. The seller's account must be opted in to Business Policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy is applied to the listing. If the seller's account is not opted in to Business Policies, that seller may not use this container. Sellers must opt-in to Business Policies through My eBay or by using the optInToProgram call of the eBay Account API.

If Business Policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SellerProfiles
  .SellerPaymentProfile
SellerPaymentProfileType Conditionally The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileID
long Conditionally The unique identifier of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

Payment profile IDs can be retrieved with the getPaymentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

In the 'Get' calls, the PaymentProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment profile.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileName
string Conditionally The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

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

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SellerProfiles
  .SellerReturnProfile
  .ReturnProfileID
long Conditionally The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

Return Policy profile IDs can be retrieved with the getReturnPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

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

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

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileID
long Conditionally The unique identifier of a Business Policies shipping profile. A ShippingProfileID and/or a ShipppingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the Shippping values of a Business Policies shipping profile. If both fields are provided and their values don't match, the ShipppingProfileID takes precedence.

Shipping profile IDs can be retrieved with the getFulfillmentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

In the 'Get' calls, the ShipppingProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ShipppingProfileName value will be returned if a name is assigned to the shipping profile.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileName
string Conditionally The name of a Business Policies shipping profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shipping values of a Business Policies shipping profile. If both fields are provided and their values don't match, the ShippingProfileID takes precedence.

In the 'Get' calls, the ShippingProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the payment profile.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SellingStatus
  .QuantitySold
int Conditionally The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

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

In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item.

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

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

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.ShippingDetails
  .GlobalShipping
boolean Conditionally Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, international shipping through the Global Shipping Program is available for the listing, and eBay automatically sets one of the available shipping service options to International Priority Shipping. If the value of GlobalShipping is false, the seller is responsible for specifying one or more international shipping service options if the seller is willing to ship internationally.

When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change.

Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program.

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

See Introduction to Shipping for information about Global Shipping Program eligibility.

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

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


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

See Determining Shipping Costs for a Listing.

DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.SKU
SKUType (string) Conditionally A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus

A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.)

If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

For multiple-variation listings, a SKU value is actually required for each product variation within the listing. However, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request.

Note: The eBay site cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.)

For GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing.

Max length: 50.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

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

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

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

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Variations.Variation
  .Quantity
int Conditionally This value indicates the quantity of items in the specific variation that are available for purchase. If you set Variation.Quantity to 0 when you create, revise, or relist an item listing, the variation is dropped from the listing. To prevent this, you can set SetUserPreferences.OutOfStockControlPreference to true.

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

For RelistFixedPriceItem:
  • For an item variation that had an available quantity greater than 0 when the listing ended, the Quantity value of the item variation for the newly relisted item is set to the actual quantity available. For item variations, there is actually no QuantityAvailable field, but this value may be derived if you look at the corresponding item variation in a GetMyeBaySelling) response and subtract the Variation.QuantitySold value from the Variation.Quantity value, which represents the original Variation.Quantity value at creation time of the previous listing.
  • For item variations with an available quantity of 0 when the listing ended, the relisted item will retain the Variaton.Quantity value that was passed in at creation time of the previous listing.
So, if you are relisting an item that had one or more item variations with an available quantity of 0 when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding Variation.Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value, while also making sure to pass in the correct SKU value(s) to identify the correct item variation. A ReviseInventoryStatus call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings).

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

For GetSellerTransactions: See Item.Quantityinstead.

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

Note: The number in the Variation.Quantity field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup, eBay Now, or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to 0, and the Item.IgnoreQuantity will also be returned as True.


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

See:
    Describing Variations in a Listing
    Using the Out-of-Stock Feature for more details

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Variations.Variation
  .SellingStatus
SellingStatusType Conditionally Contains the variation's quantity sold. Always returned when variations are present.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Variations.Variation
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Variations.Variation
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Variations.Variation
  .SellingStatus.CurrentPrice
AmountType (double) Conditionally The current price of the item in the original listing currency.

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

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

In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Variations.Variation
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Variations.Variation
  .SellingStatus.QuantitySold
int Conditionally The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

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

In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item.

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

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

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

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

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

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

See Describing Variations in a Listing.

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Variations.Variation
  .StartPrice
AmountType (double) Conditionally The fixed price for this item variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

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

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

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

See Describing Variations in a Listing.

DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Variations.Variation
  .StartPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The fixed price for this item variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

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

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

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

DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Variations.Variation
  .VariationTitle
string Conditionally The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify item variations(for buyers and sellers).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.Variations.Variation
  .WatchCount
long Conditionally The number of watches placed on this variation by eBay users.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .Item.WatchCount
long Conditionally The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .OrderTransactionArray
  .OrderTransaction.Transaction
  .SellerPaidStatus
PaidStatusCodeType Conditionally Specifies the paid status of the order.

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

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

DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromSoldList
  .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.
DeletedFromUnsoldList PaginatedItemArrayType Conditionally This container consists of listings that have ended without sales and have been deleted from My eBay. This container will be returned if the eBay user has one or more listings with sales that have been deleted from My eBay.

This container will not be returned in the response (even if there are one or more listings that have sales but have been deleted) if the DetailLevel value is set to ReturnSummary and the DeletedFromSoldList.Include field is omitted or set to false.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromUnsoldList
  .ItemArray
ItemArrayType Conditionally Contains a list of Item types.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .ItemArray.Item
  .ClassifiedAdPayPerLeadFee
AmountType (double) Conditionally The email and phone lead fee for a pay-per-lead item.

DetailLevel: ReturnAll.
DeletedFromUnsoldList
  .ItemArray.Item
  .ClassifiedAdPayPerLeadFee
  [ attribute currencyID ]
CurrencyCodeType Conditionally The email and phone lead fee for a pay-per-lead item.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromUnsoldList
  .ItemArray.Item.HideFromSearch
boolean Conditionally This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .ItemArray.Item.ListingDetails
  .ConvertedReservePrice
AmountType (double) Conditionally Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromUnsoldList
  .ItemArray.Item.ListingDetails
  .ConvertedReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price listings.

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

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

DeletedFromUnsoldList
  .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).
DeletedFromUnsoldList
  .ItemArray.Item.Quantity
int Conditionally For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations.

For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1.

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

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

For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1.

For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value.

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

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
    Selecting a Selling Format

DeletedFromUnsoldList
  .ItemArray.Item
  .QuantityAvailable
int Conditionally This integer value indicates the quantity of an item that is still available for purchase in a multiple-quantity, fixed-price listing. This field is not applicable to auction listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromUnsoldList
  .ItemArray.Item.QuestionCount
long Conditionally Specifies the number of questions buyers have posted about the item. Returned only if greater than 0.
DeletedFromUnsoldList
  .ItemArray.Item
  .ReasonHideFromSearch
ReasonHideFromSearchCodeType Conditionally This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.

Applicable values:

DuplicateListing
(out) This value indicates that the auction listing is being hidden from search on the eBay site because the listing has been determined by eBay to be a duplicate listing with zero bids.

This enumeration is associated with eBay Duplicate Listings Policy, which has taken effect on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read eBay's Duplicate Listings Policy help page.
OutOfStock
(out) This value indicates that the listing is hidden from search because the quantity is zero. However, the listing is still alive and will reappear in the search results when the quantity is set to something greater than zero. For more information, see SetUserPreferences.OutOfStockControlPreference.

Code so that your app gracefully handles any future changes to this list.
DeletedFromUnsoldList
  .ItemArray.Item.ReservePrice
AmountType (double) Conditionally The lowest price at which the seller is willing to sell an auction item. (StartPrice must be lower than ReservePrice .) Not all categories support a Reserve Price. Use GetCategories to see if a category supports a Reserve Price. In calls that retrieve item data, the ReservePrice field will only be returned to the auction item's seller, and only if a Reserve Price has been set up. A Reserve Price is not applicable to fixed-price or classified ad listings.

You can remove the Reserve price of a US eBay Motors listing if the category allows it, the current Reserve Price has not been met, and the Reserve Price is at least $2.00 more than the current high bid. In this case, if the item has bids, the Reserve Price is set to $1.00 over the current high bid. The next bid meets the Reserve Price and wins. See Fees Overview below for information about fee credits that may be available when the Reserve Price is removed for a Motors listing.

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

See:
    Revising Items
    Reserve Price (eBay site help)
    Fees Overview (eBay site help)
    Determining Whether a Category Supports Reserve Prices

DeletedFromUnsoldList
  .ItemArray.Item.ReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The lowest price at which the seller is willing to sell an auction item. (StartPrice must be lower than ReservePrice .) Not all categories support a Reserve Price. Use GetCategories to see if a category supports a Reserve Price. In calls that retrieve item data, the ReservePrice field will only be returned to the auction item's seller, and only if a Reserve Price has been set up. A Reserve Price is not applicable to fixed-price or classified ad listings.

You can remove the Reserve price of a US eBay Motors listing if the category allows it, the current Reserve Price has not been met, and the Reserve Price is at least $2.00 more than the current high bid. In this case, if the item has bids, the Reserve Price is set to $1.00 over the current high bid. The next bid meets the Reserve Price and wins. See Fees Overview below for information about fee credits that may be available when the Reserve Price is removed for a Motors listing.

For a list of possible enumeration values, see CurrencyCodeType.
DeletedFromUnsoldList
  .ItemArray.Item.SellerProfiles
SellerProfilesType Conditionally This container is used if the seller would like to use/reference Business Policies to create, revise, relist, or verify their listing. The seller's account must be opted in to Business Policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy is applied to the listing. If the seller's account is not opted in to Business Policies, that seller may not use this container. Sellers must opt-in to Business Policies through My eBay or by using the optInToProgram call of the eBay Account API.

If Business Policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
DeletedFromUnsoldList
  .ItemArray.Item.SellerProfiles
  .SellerPaymentProfile
SellerPaymentProfileType Conditionally The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
DeletedFromUnsoldList
  .ItemArray.Item.SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileID
long Conditionally The unique identifier of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

Payment profile IDs can be retrieved with the getPaymentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

In the 'Get' calls, the PaymentProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment profile.
DeletedFromUnsoldList
  .ItemArray.Item.SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileName
string Conditionally The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

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

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
DeletedFromUnsoldList
  .ItemArray.Item.SellerProfiles
  .SellerReturnProfile
  .ReturnProfileID
long Conditionally The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

Return Policy profile IDs can be retrieved with the getReturnPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

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

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

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
DeletedFromUnsoldList
  .ItemArray.Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileID
long Conditionally The unique identifier of a Business Policies shipping profile. A ShippingProfileID and/or a ShipppingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the Shippping values of a Business Policies shipping profile. If both fields are provided and their values don't match, the ShipppingProfileID takes precedence.

Shipping profile IDs can be retrieved with the getFulfillmentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

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

In the 'Get' calls, the ShippingProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the payment profile.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .ItemArray.Item.SellingStatus
  .QuantitySold
int Conditionally The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

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

In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item.

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

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

DeletedFromUnsoldList
  .ItemArray.Item
  .ShippingDetails
  .GlobalShipping
boolean Conditionally Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, international shipping through the Global Shipping Program is available for the listing, and eBay automatically sets one of the available shipping service options to International Priority Shipping. If the value of GlobalShipping is false, the seller is responsible for specifying one or more international shipping service options if the seller is willing to ship internationally.

When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change.

Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program.

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

See Introduction to Shipping for information about Global Shipping Program eligibility.

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

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


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

See Determining Shipping Costs for a Listing.

DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .ItemArray.Item.SKU
SKUType (string) Conditionally A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus

A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.)

If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

For multiple-variation listings, a SKU value is actually required for each product variation within the listing. However, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request.

Note: The eBay site cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.)

For GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing.

Max length: 50.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

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

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

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

DeletedFromUnsoldList
  .ItemArray.Item.Variations
  .Variation.PrivateNotes
string Conditionally A note a user makes on an item with variations in My eBay.

For eBay.com, only GetMyeBaySelling (not GetItem) returns this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note.

Not supported as input in ReviseFixedPriceItem. Use SetUserNotes instead.

In SoldList, notes for variations are only returned at the Item level, not the variation level.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromUnsoldList
  .ItemArray.Item.Variations
  .Variation.Quantity
int Conditionally This value indicates the quantity of items in the specific variation that are available for purchase. If you set Variation.Quantity to 0 when you create, revise, or relist an item listing, the variation is dropped from the listing. To prevent this, you can set SetUserPreferences.OutOfStockControlPreference to true.

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

For RelistFixedPriceItem:
  • For an item variation that had an available quantity greater than 0 when the listing ended, the Quantity value of the item variation for the newly relisted item is set to the actual quantity available. For item variations, there is actually no QuantityAvailable field, but this value may be derived if you look at the corresponding item variation in a GetMyeBaySelling) response and subtract the Variation.QuantitySold value from the Variation.Quantity value, which represents the original Variation.Quantity value at creation time of the previous listing.
  • For item variations with an available quantity of 0 when the listing ended, the relisted item will retain the Variaton.Quantity value that was passed in at creation time of the previous listing.
So, if you are relisting an item that had one or more item variations with an available quantity of 0 when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding Variation.Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value, while also making sure to pass in the correct SKU value(s) to identify the correct item variation. A ReviseInventoryStatus call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings).

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

For GetSellerTransactions: See Item.Quantityinstead.

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

Note: The number in the Variation.Quantity field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup, eBay Now, or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to 0, and the Item.IgnoreQuantity will also be returned as True.


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

See:
    Describing Variations in a Listing
    Using the Out-of-Stock Feature for more details

DeletedFromUnsoldList
  .ItemArray.Item.Variations
  .Variation.SellingStatus
SellingStatusType Conditionally Contains the variation's quantity sold. Always returned when variations are present.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromUnsoldList
  .ItemArray.Item.Variations
  .Variation.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.
DeletedFromUnsoldList
  .ItemArray.Item.Variations
  .Variation.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.
DeletedFromUnsoldList
  .ItemArray.Item.Variations
  .Variation.SellingStatus
  .CurrentPrice
AmountType (double) Conditionally The current price of the item in the original listing currency.

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

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

In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale.
DeletedFromUnsoldList
  .ItemArray.Item.Variations
  .Variation.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.
DeletedFromUnsoldList
  .ItemArray.Item.Variations
  .Variation.SellingStatus
  .QuantitySold
int Conditionally The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

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

In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item.

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

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

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

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

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

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

See Describing Variations in a Listing.

DeletedFromUnsoldList
  .ItemArray.Item.Variations
  .Variation.StartPrice
AmountType (double) Conditionally The fixed price for this item variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

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

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

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

See Describing Variations in a Listing.

DeletedFromUnsoldList
  .ItemArray.Item.Variations
  .Variation.StartPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The fixed price for this item variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

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

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

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

DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .ItemArray.Item.Variations
  .Variation.VariationTitle
string Conditionally The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify item variations(for buyers and sellers).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromUnsoldList
  .ItemArray.Item.Variations
  .Variation.WatchCount
long Conditionally The number of watches placed on this variation by eBay users.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
DeletedFromUnsoldList
  .ItemArray.Item.WatchCount
long Conditionally The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
DeletedFromUnsoldList
  .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.
ScheduledList PaginatedItemArrayType Conditionally This container consists of the items that are scheduled to become active at a future date/time. This container will be returned if the eBay user has one or more listings scheduled to become active at a future date/time.

This container will not be returned in the response (even if there are listings scheduled to become active) if the DetailLevel value is set to ReturnSummary and the ScheduledList.Include field is omitted or set to false.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ScheduledList.ItemArray ItemArrayType Conditionally Contains a list of Item types.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ScheduledList.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.
ScheduledList.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.
ScheduledList.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.
ScheduledList.ItemArray.Item
  .ClassifiedAdPayPerLeadFee
AmountType (double) Conditionally The email and phone lead fee for a pay-per-lead item.

DetailLevel: ReturnAll.
ScheduledList.ItemArray.Item
  .ClassifiedAdPayPerLeadFee
  [ attribute currencyID ]
CurrencyCodeType Conditionally The email and phone lead fee for a pay-per-lead item.

For a list of possible enumeration values, see CurrencyCodeType.
ScheduledList.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.
ScheduledList.ItemArray.Item
  .HideFromSearch
boolean Conditionally This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
ScheduledList.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.
ScheduledList.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.
ScheduledList.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.
ScheduledList.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.
ScheduledList.ItemArray.Item
  .ListingDetails
  .ConvertedReservePrice
AmountType (double) Conditionally Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ScheduledList.ItemArray.Item
  .ListingDetails
  .ConvertedReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price listings.

For a list of possible enumeration values, see CurrencyCodeType.
ScheduledList.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.
ScheduledList.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.
ScheduledList.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.
ScheduledList.ItemArray.Item
  .ListingDuration
token Conditionally Describes the number of days the seller wants the listing to be active (available for bidding/buying). The duration specifies the seller's initial intent at listing time.

The end time for a listing is calculated by adding the duration to the item's start time. If the listing ends early, the value of the listing duration does not change. When a listing's duration is changed, any related fees (e.g., 10-day fee) may be debited or credited (as applicable).

The valid choice of values depends on the listing format (see Item.ListingType). For a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll and look for ListingDurations information.

When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours.

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

See:
    GetCategoryFeatures
    Fees per Site



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

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

ScheduledList.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).
ScheduledList.ItemArray.Item
  .Quantity
int Conditionally For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations.

For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1.

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

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

For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1.

For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value.

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

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
    Selecting a Selling Format

ScheduledList.ItemArray.Item
  .QuantityAvailable
int Conditionally This integer value indicates the quantity of an item that is still available for purchase in a multiple-quantity, fixed-price listing. This field is not applicable to auction listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ScheduledList.ItemArray.Item
  .QuestionCount
long Conditionally Specifies the number of questions buyers have posted about the item. Returned only if greater than 0.
ScheduledList.ItemArray.Item
  .ReasonHideFromSearch
ReasonHideFromSearchCodeType Conditionally This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.

Applicable values:

DuplicateListing
(out) This value indicates that the auction listing is being hidden from search on the eBay site because the listing has been determined by eBay to be a duplicate listing with zero bids.

This enumeration is associated with eBay Duplicate Listings Policy, which has taken effect on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read eBay's Duplicate Listings Policy help page.
OutOfStock
(out) This value indicates that the listing is hidden from search because the quantity is zero. However, the listing is still alive and will reappear in the search results when the quantity is set to something greater than zero. For more information, see SetUserPreferences.OutOfStockControlPreference.

Code so that your app gracefully handles any future changes to this list.
ScheduledList.ItemArray.Item
  .ReservePrice
AmountType (double) Conditionally The lowest price at which the seller is willing to sell an auction item. (StartPrice must be lower than ReservePrice .) Not all categories support a Reserve Price. Use GetCategories to see if a category supports a Reserve Price. In calls that retrieve item data, the ReservePrice field will only be returned to the auction item's seller, and only if a Reserve Price has been set up. A Reserve Price is not applicable to fixed-price or classified ad listings.

You can remove the Reserve price of a US eBay Motors listing if the category allows it, the current Reserve Price has not been met, and the Reserve Price is at least $2.00 more than the current high bid. In this case, if the item has bids, the Reserve Price is set to $1.00 over the current high bid. The next bid meets the Reserve Price and wins. See Fees Overview below for information about fee credits that may be available when the Reserve Price is removed for a Motors listing.

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

See:
    Revising Items
    Reserve Price (eBay site help)
    Fees Overview (eBay site help)
    Determining Whether a Category Supports Reserve Prices

ScheduledList.ItemArray.Item
  .ReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The lowest price at which the seller is willing to sell an auction item. (StartPrice must be lower than ReservePrice .) Not all categories support a Reserve Price. Use GetCategories to see if a category supports a Reserve Price. In calls that retrieve item data, the ReservePrice field will only be returned to the auction item's seller, and only if a Reserve Price has been set up. A Reserve Price is not applicable to fixed-price or classified ad listings.

You can remove the Reserve price of a US eBay Motors listing if the category allows it, the current Reserve Price has not been met, and the Reserve Price is at least $2.00 more than the current high bid. In this case, if the item has bids, the Reserve Price is set to $1.00 over the current high bid. The next bid meets the Reserve Price and wins. See Fees Overview below for information about fee credits that may be available when the Reserve Price is removed for a Motors listing.

For a list of possible enumeration values, see CurrencyCodeType.
ScheduledList.ItemArray.Item
  .SellerProfiles
SellerProfilesType Conditionally This container is used if the seller would like to use/reference Business Policies to create, revise, relist, or verify their listing. The seller's account must be opted in to Business Policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy is applied to the listing. If the seller's account is not opted in to Business Policies, that seller may not use this container. Sellers must opt-in to Business Policies through My eBay or by using the optInToProgram call of the eBay Account API.

If Business Policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
ScheduledList.ItemArray.Item
  .SellerProfiles
  .SellerPaymentProfile
SellerPaymentProfileType Conditionally The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
ScheduledList.ItemArray.Item
  .SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileID
long Conditionally The unique identifier of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

Payment profile IDs can be retrieved with the getPaymentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

In the 'Get' calls, the PaymentProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment profile.
ScheduledList.ItemArray.Item
  .SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileName
string Conditionally The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

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

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
ScheduledList.ItemArray.Item
  .SellerProfiles
  .SellerReturnProfile
  .ReturnProfileID
long Conditionally The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

Return Policy profile IDs can be retrieved with the getReturnPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

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

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

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
ScheduledList.ItemArray.Item
  .SellerProfiles
  .SellerShippingProfile
  .ShippingProfileID
long Conditionally The unique identifier of a Business Policies shipping profile. A ShippingProfileID and/or a ShipppingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the Shippping values of a Business Policies shipping profile. If both fields are provided and their values don't match, the ShipppingProfileID takes precedence.

Shipping profile IDs can be retrieved with the getFulfillmentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

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

In the 'Get' calls, the ShippingProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the payment profile.
ScheduledList.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.
ScheduledList.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.
ScheduledList.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.
ScheduledList.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.
ScheduledList.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.
ScheduledList.ItemArray.Item
  .SellingStatus.QuantitySold
int Conditionally The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

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

In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item.

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

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

ScheduledList.ItemArray.Item
  .ShippingDetails
  .GlobalShipping
boolean Conditionally Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, international shipping through the Global Shipping Program is available for the listing, and eBay automatically sets one of the available shipping service options to International Priority Shipping. If the value of GlobalShipping is false, the seller is responsible for specifying one or more international shipping service options if the seller is willing to ship internationally.

When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change.

Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program.

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

See Introduction to Shipping for information about Global Shipping Program eligibility.

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

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