Trading API885

GetSellerList

Use this call to retrieve items listed by the authenticated user, including item data.

GetSellerList returns an array of zero or more items, depending on the user's activity and the inputs used in the call. Input fields can increase or filter the data returned. See Browsing a Seller's Items for a detailed description of retrieving items using GetSellerList.

Usage Details

In all calls, at least one date-range filter must be specified.

You can specify a DetailLevel to control the response data. If you set a DetailLevel, you must set pagination values.

GetSellerList returns a maximum of 5,000 items per call (this is possible if you do not specify a Detail Level, and thus return the smallest set of data for each item). However, if you specify any DetailLevel value (and thus increase the fields returned for each item), you might need to use Pagination values to obtain the complete result set. If you use a DetailLevel, the response can contain no more than 200 items per call.

Many item details (such as item descriptions and listing enhancements) don't change often, and getting these values adds to the overhead of your calls. After you initially download the details for a set of items, subsequent requests for those items should retrieve only the item information that is likely to change. It is best to avoid using a DetailLevel of ReturnAll or a GranularityLevel of Fine with GetSellerList. Or consider using GetSellerEvents instead of GetSellerList.

If you need to use ReturnAll to retrieve all the item details, use a smaller EntriesPerPage value to limit the number of items returned from the call. To improve performance, specify a shorter time range with EndTimeFrom and EndTimeTo.

You can specify either a DetailLevel or a GranularityLevel in your request, but not both. See Specifying Detail Levels and Granularity Levels for more information about detail levels.

Use Pagination to control the pages of data returned. The Pagination.EntriesPerPage field controls how many items are returned per call, and Pagination.PageNumber specifies which page of data to retrieve in the current call. The value specified for EntriesPerPage must be between 1 and 200.

You can use multiple date-range filters in the same call. For example, you can use StartTimeFrom and StartTimeTo if you want the response to contain listings that started between the two times. Use EndTimeFrom and EndTimeTo to return listings ending between the two times.

Working with the Response

GetSellerList returns a list of the sellers items in an ItemArray container.

In the output, the ReturnedItemCountActual property indicates how many items were returned by the call; Count indicates how many items could be returned. HasMoreItems, if true, indicates that there are more items to be returned, requiring one or more additional calls. PageNumber indicates the page of data returned and ItemsPerPage indicates the number of items returned per call.

Testing GetSellerList

You can test this call in the Sandbox environment after you use AddItem to add at least two items.

Some values are only returned if the call requestor is the seller of the item. To test the call from the perspective of another user, call GetSellerList with a user other than the one who listed the item.

For applications that list different types of items (such as Chinese auctions and fixed-price items), create all possible types of listings using AddItem, then attempt to retrieve the data with GetSellerList.

If applicable to the application's use cases, list test items with flat and calculated shipping rates. Then retrieve the items with GetSellerList.

For applications that create competitive-bid item listings (Chinese auctions), bid on the items using the Sandbox user interface before retrieving the item using GetSellerList. This will populate the high bidder data for items in the result set.

Test calls to GetSellerList with different combinations of detail level, pagination, and date-based filtering to cover all of the possible scenarios the application might have to accommodate under real world conditions.

Related Information

See:
    GetSellerList
    Browsing a Seller's Items

See also the reference documentation for these calls:



Back to top

GetSellerList Input

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

See also Samples.

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

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetSellerListRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <AdminEndedItemsOnly> boolean </AdminEndedItemsOnly>
  <CategoryID> int </CategoryID>
  <EndTimeFrom> dateTime </EndTimeFrom>
  <EndTimeTo> dateTime </EndTimeTo>
  <GranularityLevel> GranularityLevelCodeType </GranularityLevel>
  <IncludeVariations> boolean </IncludeVariations>
  <IncludeWatchCount> boolean </IncludeWatchCount>
  <MotorsDealerUsers> UserIDArrayType
    <UserID> UserIDType (string) </UserID>
    <!-- ... more UserID values allowed here ... -->
  </MotorsDealerUsers>
  <Pagination> PaginationType
    <EntriesPerPage> int </EntriesPerPage>
    <PageNumber> int </PageNumber>
  </Pagination>
  <SKUArray> SKUArrayType
    <SKU> SKUType (string) </SKU>
    <!-- ... more SKU values allowed here ... -->
  </SKUArray>
  <Sort> int </Sort>
  <StartTimeFrom> dateTime </StartTimeFrom>
  <StartTimeTo> dateTime </StartTimeTo>
  <UserID> UserIDType (string) </UserID>
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel values allowed here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector values allowed here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetSellerListRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
AdminEndedItemsOnly boolean Optional Specifies whether to return only items that were administratively ended based on a policy violation.
CategoryID int Optional The category ID for the items retrieved. If you specify CategoryID in a GetSellerList call, the response contains only items in the category you specify.
EndTimeFrom dateTime Conditional Specifies the earliest (oldest) date to use in a date range filter based on item end time. Specify either an end-time range or a start-time range filter in every call request. Each of the time ranges must be a value less than 120 days.
EndTimeTo dateTime Conditional Specifies the latest (most recent) date to use in a date range filter based on item end time. Must be specified if EndTimeFrom is specified.
GranularityLevel GranularityLevelCodeType Optional Specifies the subset of item and user fields to return. See GetSellerList in the eBay Features Guide for a list of the fields that are returned for each granularity level. For GetSellerList, use DetailLevel or GranularityLevel in a request, but not both. For GetSellerList, if GranularityLevel is specified, DetailLevel is ignored.

Applicable values:

•   Coarse

(in) For each record in the response, retrieves less data than Medium. See the eBay Features Guide for a list of the output fields that are returned when this level is specified.

•   CustomCode

(in)

•   Fine

(in) For each record in the response, retrieves more data than Medium. See the eBay Features Guide for a list of the output fields that are returned when this level is specified.

•   Medium

(in) For each record in the response, retrieves more data than Coarse and less data than Fine. See the eBay Features Guide for a list of the output fields that are returned when this level is specified.


See GetSellerList.

IncludeVariations boolean Optional If true, the Variations node is returned for all multi-variation listings in the response.

Please note that if the seller includes a large number of variations in many listings, using this flag may degrade the call's performance. Therefore, when you use this flag, you may need to reduce the total number of items you're requesting at once. For example, you may need to use shorter time ranges in the EndTime or StartTime filters, fewer entries per page in Pagination, and/or SKUArray.
IncludeWatchCount boolean Optional Specifies whether to include WatchCount in Item nodes returned. WatchCount is only returned with DetailLevel ReturnAll.
MotorsDealerUsers UserIDArrayType Optional Specifies the list of Motors Dealer sellers for which a special set of metrics can be requested. Applies to eBay Motors Pro applications only.
MotorsDealerUsers.UserID UserIDType (string) Optional,
repeatable: [0..*]
Unique eBay user ID for the user. Applies to eBay Motors Pro applications only.
Pagination PaginationType Required Contains the data controlling the pagination of the returned values. If you set a DetailLevel in this call, you must set pagination values. The Pagination field contains the number of items to be returned per page of data (per call), and the page number to return with the current call.
Pagination.EntriesPerPage int Required This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.

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

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

For GetProducts, the maximum value is 20, and any higher values are ignored.
Pagination.PageNumber int Required Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value.
SKUArray SKUArrayType Optional Container for a set of SKUs. Filters (reduces) the response to only include active listings that the seller listed with any of the specified SKUs. If multiple listings include the same SKU, they are all returned (assuming they also match the other criteria in the GetSellerList request).

SKUArray can be used to retrieve items listed by the user identified in AuthToken or in UserID.

Note: Listings with matching SKUs are returned regardless of their Item.InventoryTrackingMethod settings.
SKUArray.SKU SKUType (string) Optional,
repeatable: [0..*]
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. 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.)

A SKU is not required to be unique. A seller can specify a particular SKU value on one item or on multiple items. Different sellers can use the same SKUs.

If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus.

Note: AddFixedPriceItem and RelistFixedPriceItem are defined in the Merchant Data API (part of Large Merchant Services).
Max length: 50.
Sort int Optional Specifies the order in which returned items are sorted (based on the end dates of the item listings). Valid values:
0 = No sorting
1 = Sort in descending order
2 = Sort in ascending order
StartTimeFrom dateTime Conditional Specifies the earliest (oldest) date to use in a date range filter based on item start time. Each of the time ranges must be a value less than 120 days. In all calls, at least one date-range filter must be specified (i.e., you must specify either the end time range or start time range in every request).
StartTimeTo dateTime Conditional Specifies the latest (most recent) date to use in a date range filter based on item start time. Must be specified if StartTimeFrom is specified.
UserID UserIDType (string) Optional Specifies the seller whose items will be returned. UserID is an optional input. If not specified, retrieves listings for the user identified by the authentication token passed in the request. Note that since user information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers looking for information about their own listings and bidders who know the user IDs of their sellers will be able to make this API call successfully.

See Working with Anonymous User Information.

Standard Input Fields  
DetailLevel DetailLevelCodeType Optional,
repeatable: [0..*]
Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request.

The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level.

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:

•   ItemReturnDescription

(in) Returns Description, plus the ListingDesigner node and some additional information if applicable

•   ReturnAll

(in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.


(Not all values in DetailLevelCodeType apply to this field.)
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US).

ID Country
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) Return warnings when the application passes unrecognized or deprecated elements in a request.

•   Low

(in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified.


See Warning Level.



Back to top

GetSellerList Output

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

See also Samples.

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

<?xml version="1.0" encoding="utf-8"?>
<GetSellerListResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <HasMoreItems> boolean </HasMoreItems>
  <ItemArray> ItemArrayType
    <Item> ItemType
      <ApplicationData> string </ApplicationData>
      <AutoPay> boolean </AutoPay>
      <BuyerGuaranteePrice currencyID="CurrencyCodeType"> AmountType (double) </BuyerGuaranteePrice>
      <BuyerProtection> BuyerProtectionCodeType </BuyerProtection>
      <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
      <Charity> CharityType
        <CharityID> string </CharityID>
        <CharityListing> boolean </CharityListing>
        <CharityName> string </CharityName>
        <CharityNumber> int </CharityNumber>
        <DonationPercent> float </DonationPercent>
        <LogoURL> string </LogoURL>
        <Mission> string </Mission>
        <Status> CharityStatusCodeType </Status>
      </Charity>
      <ConditionDescription> string </ConditionDescription>
      <ConditionDisplayName> string </ConditionDisplayName>
      <ConditionID> int </ConditionID>
      <Country> CountryCodeType </Country>
      <CrossBorderTrade> string </CrossBorderTrade>
      <!-- ... more CrossBorderTrade values allowed here ... -->
      <Currency> CurrencyCodeType </Currency>
      <Description> string </Description>
      <DisableBuyerRequirements> boolean </DisableBuyerRequirements>
      <eBayNowEligible> boolean </eBayNowEligible>
      <ExtendedSellerContactDetails> ExtendedContactDetailsType
        <ContactHoursDetails> ContactHoursDetailsType
          <Hours1AnyTime> boolean </Hours1AnyTime>
          <Hours1Days> DaysCodeType </Hours1Days>
          <Hours1From> time </Hours1From>
          <Hours1To> time </Hours1To>
          <Hours2AnyTime> boolean </Hours2AnyTime>
          <Hours2Days> DaysCodeType </Hours2Days>
          <Hours2From> time </Hours2From>
          <Hours2To> time </Hours2To>
          <TimeZoneID> string </TimeZoneID>
        </ContactHoursDetails>
      </ExtendedSellerContactDetails>
      <FreeAddedCategory> CategoryType
        <CategoryID> string </CategoryID>
        <CategoryName> string </CategoryName>
      </FreeAddedCategory>
      <GetItFast> boolean </GetItFast>
      <GiftIcon> int </GiftIcon>
      <HitCount> long </HitCount>
      <HitCounter> HitCounterCodeType </HitCounter>
      <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
      <InventoryTrackingMethod> InventoryTrackingMethodCodeType </InventoryTrackingMethod>
      <ItemID> ItemIDType (string) </ItemID>
      <ItemPolicyViolation> ItemPolicyViolationType
        <PolicyID> long </PolicyID>
        <PolicyText> string </PolicyText>
      </ItemPolicyViolation>
      <ListingCheckoutRedirectPreference> ListingCheckoutRedirectPreferenceType
        <ProStoresStoreName> string </ProStoresStoreName>
        <SellerThirdPartyUsername> string </SellerThirdPartyUsername>
      </ListingCheckoutRedirectPreference>
      <ListingDesigner> ListingDesignerType
        <LayoutID> int </LayoutID>
        <OptimalPictureSize> boolean </OptimalPictureSize>
        <ThemeID> int </ThemeID>
      </ListingDesigner>
      <ListingDetails> ListingDetailsType
        <Adult> boolean </Adult>
        <BestOfferAutoAcceptPrice currencyID="CurrencyCodeType"> AmountType (double) </BestOfferAutoAcceptPrice>
        <BindingAuction> boolean </BindingAuction>
        <CheckoutEnabled> boolean </CheckoutEnabled>
        <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
        <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
        <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
        <EndTime> dateTime </EndTime>
        <HasPublicMessages> boolean </HasPublicMessages>
        <HasReservePrice> boolean </HasReservePrice>
        <HasUnansweredQuestions> boolean </HasUnansweredQuestions>
        <MinimumBestOfferPrice currencyID="CurrencyCodeType"> AmountType (double) </MinimumBestOfferPrice>
        <RelistedItemID> ItemIDType (string) </RelistedItemID>
        <StartTime> dateTime </StartTime>
        <TCROriginalItemID> ItemIDType (string) </TCROriginalItemID>
        <ViewItemURL> anyURI </ViewItemURL>
        <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
      </ListingDetails>
      <ListingDuration> token </ListingDuration>
      <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
      <!-- ... more ListingEnhancement values allowed here ... -->
      <ListingSubtype2> ListingSubtypeCodeType </ListingSubtype2>
      <ListingType> ListingTypeCodeType </ListingType>
      <Location> string </Location>
      <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
      <OutOfStockControl> boolean </OutOfStockControl>
      <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
      <!-- ... more PaymentMethods values allowed here ... -->
      <PickupInStoreDetails> PickupInStoreDetailsType
        <EligibleForPickupDropOff> boolean </EligibleForPickupDropOff>
        <EligibleForPickupInStore> boolean </EligibleForPickupInStore>
      </PickupInStoreDetails>
      <PictureDetails> PictureDetailsType </PictureDetails>
      <PostCheckoutExperienceEnabled> boolean </PostCheckoutExperienceEnabled>
      <PrimaryCategory> CategoryType
        <CategoryID> string </CategoryID>
        <CategoryName> string </CategoryName>
      </PrimaryCategory>
      <PrivateListing> boolean </PrivateListing>
      <ProxyItem> boolean </ProxyItem>
      <Quantity> int </Quantity>
      <QuantityAvailableHint> QuantityAvailableHintCodeType </QuantityAvailableHint>
      <QuantityThreshold> int </QuantityThreshold>
      <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
      <ReturnPolicy> ReturnPolicyType
        <Description> string </Description>
        <EAN> string </EAN>
        <Refund> string </Refund>
        <RefundOption> token </RefundOption>
        <RestockingFeeValue> token </RestockingFeeValue>
        <RestockingFeeValueOption> token </RestockingFeeValueOption>
        <ReturnsAccepted> string </ReturnsAccepted>
        <ReturnsAcceptedOption> token </ReturnsAcceptedOption>
        <ReturnsWithin> string </ReturnsWithin>
        <ReturnsWithinOption> token </ReturnsWithinOption>
        <ShippingCostPaidBy> string </ShippingCostPaidBy>
        <ShippingCostPaidByOption> token </ShippingCostPaidByOption>
        <WarrantyDuration> string </WarrantyDuration>
        <WarrantyDurationOption> token </WarrantyDurationOption>
        <WarrantyOffered> string </WarrantyOffered>
        <WarrantyOfferedOption> token </WarrantyOfferedOption>
        <WarrantyType> string </WarrantyType>
        <WarrantyTypeOption> token </WarrantyTypeOption>
      </ReturnPolicy>
      <ReviseStatus> ReviseStatusType
        <ItemRevised> boolean </ItemRevised>
      </ReviseStatus>
      <SecondaryCategory> CategoryType
        <CategoryID> string </CategoryID>
        <CategoryName> string </CategoryName>
      </SecondaryCategory>
      <SellerContactDetails> AddressType </SellerContactDetails>
      <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
        <AdminEnded> boolean </AdminEnded>
        <BidCount> int </BidCount>
        <BidIncrement currencyID="CurrencyCodeType"> AmountType (double) </BidIncrement>
        <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
        <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
        <HighBidder> UserType
          <AboutMePage> boolean </AboutMePage>
          <BuyerInfo> BuyerType
            <ShippingAddress> AddressType
              <Country> CountryCodeType </Country>
              <PostalCode> string </PostalCode>
            </ShippingAddress>
          </BuyerInfo>
          <eBayGoodStanding> boolean </eBayGoodStanding>
          <EIASToken> string </EIASToken>
          <Email> string </Email>
          <FeedbackPrivate> boolean </FeedbackPrivate>
          <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
          <FeedbackScore> int </FeedbackScore>
          <IDVerified> boolean </IDVerified>
          <NewUser> boolean </NewUser>
          <RegistrationDate> dateTime </RegistrationDate>
          <Site> SiteCodeType </Site>
          <Status> UserStatusCodeType </Status>
          <UserAnonymized> boolean </UserAnonymized>
          <UserID> UserIDType (string) </UserID>
          <UserIDChanged> boolean </UserIDChanged>
          <UserIDLastChanged> dateTime </UserIDLastChanged>
          <VATStatus> VATStatusCodeType </VATStatus>
        </HighBidder>
        <LeadCount> int </LeadCount>
        <ListingStatus> ListingStatusCodeType </ListingStatus>
        <MinimumToBid currencyID="CurrencyCodeType"> AmountType (double) </MinimumToBid>
        <PromotionalSaleDetails> PromotionalSaleDetailsType
          <EndTime> dateTime </EndTime>
          <OriginalPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalPrice>
          <StartTime> dateTime </StartTime>
        </PromotionalSaleDetails>
        <QuantitySold> int </QuantitySold>
        <ReserveMet> boolean </ReserveMet>
        <SecondChanceEligible> boolean </SecondChanceEligible>
      </SellingStatus>
      <ShippingDetails> ShippingDetailsType
        <AllowPaymentEdit> boolean </AllowPaymentEdit>
        <CalculatedShippingRate> CalculatedShippingRateType
          <InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts>
          <OriginatingPostalCode> string </OriginatingPostalCode>
          <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
          <ShippingIrregular> boolean </ShippingIrregular>
          <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
          <WeightMajor> MeasureType (decimal) </WeightMajor>
          <WeightMinor> MeasureType (decimal) </WeightMinor>
        </CalculatedShippingRate>
        <ExcludeShipToLocation> string </ExcludeShipToLocation>
        <!-- ... more ExcludeShipToLocation values allowed here ... -->
        <GlobalShipping> boolean </GlobalShipping>
        <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
        <InternationalShippingServiceOption> InternationalShippingServiceOptionsType
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShipToLocation> string </ShipToLocation>
          <!-- ... more ShipToLocation values allowed here ... -->
        </InternationalShippingServiceOption>
        <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
        <PaymentEdited> boolean </PaymentEdited>
        <SalesTax> SalesTaxType
          <SalesTaxPercent> float </SalesTaxPercent>
          <SalesTaxState> string </SalesTaxState>
          <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
        </SalesTax>
        <SellerExcludeShipToLocationsPreference> boolean </SellerExcludeShipToLocationsPreference>
        <ShippingServiceOptions> ShippingServiceOptionsType
          <ExpeditedService> boolean </ExpeditedService>
          <LogisticPlanType> string </LogisticPlanType>
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
          <ShippingTimeMax> int </ShippingTimeMax>
          <ShippingTimeMin> int </ShippingTimeMin>
        </ShippingServiceOptions>
        <!-- ... more ShippingServiceOptions nodes allowed here ... -->
        <TaxTable> TaxTableType
          <TaxJurisdiction> TaxJurisdictionType
            <JurisdictionID> string </JurisdictionID>
            <SalesTaxPercent> float </SalesTaxPercent>
            <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
          </TaxJurisdiction>
          <!-- ... more TaxJurisdiction nodes allowed here ... -->
        </TaxTable>
      </ShippingDetails>
      <ShippingPackageDetails> ShipPackageDetailsType
        <ShippingIrregular> boolean </ShippingIrregular>
        <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
        <WeightMajor> MeasureType (decimal) </WeightMajor>
        <WeightMinor> MeasureType (decimal) </WeightMinor>
      </ShippingPackageDetails>
      <ShippingServiceCostOverrideList> ShippingServiceCostOverrideListType
        <ShippingServiceCostOverride> ShippingServiceCostOverrideType </ShippingServiceCostOverride>
        <!-- ... more ShippingServiceCostOverride nodes allowed here ... -->
      </ShippingServiceCostOverrideList>
      <ShippingTermsInDescription> boolean </ShippingTermsInDescription>
      <ShipToLocations> string </ShipToLocations>
      <!-- ... more ShipToLocations values allowed here ... -->
      <Site> SiteCodeType </Site>
      <SKU> SKUType (string) </SKU>
      <SkypeContactOption> SkypeContactOptionCodeType </SkypeContactOption>
      <!-- ... more SkypeContactOption values allowed here ... -->
      <SkypeEnabled> boolean </SkypeEnabled>
      <SkypeID> string </SkypeID>
      <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
      <Storefront> StorefrontType
        <StoreCategory2ID> long </StoreCategory2ID>
        <StoreCategoryID> long </StoreCategoryID>
        <StoreURL> anyURI </StoreURL>
      </Storefront>
      <TimeLeft> duration </TimeLeft>
      <Title> string </Title>
      <TotalQuestionCount> long </TotalQuestionCount>
      <Variations> VariationsType
        <Variation> VariationType
          <Quantity> int </Quantity>
          <SellingStatus> SellingStatusType
            <AdminEnded> boolean </AdminEnded>
            <BidCount> int </BidCount>
            <BidIncrement currencyID="CurrencyCodeType"> AmountType (double) </BidIncrement>
            <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
            <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
            <HighBidder> UserType
              <AboutMePage> boolean </AboutMePage>
              <BuyerInfo> BuyerType
                <ShippingAddress> AddressType
                  <Country> CountryCodeType </Country>
                  <PostalCode> string </PostalCode>
                </ShippingAddress>
              </BuyerInfo>
              <eBayGoodStanding> boolean </eBayGoodStanding>
              <EIASToken> string </EIASToken>
              <Email> string </Email>
              <FeedbackPrivate> boolean </FeedbackPrivate>
              <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
              <FeedbackScore> int </FeedbackScore>
              <IDVerified> boolean </IDVerified>
              <NewUser> boolean </NewUser>
              <RegistrationDate> dateTime </RegistrationDate>
              <Site> SiteCodeType </Site>
              <Status> UserStatusCodeType </Status>
              <UserAnonymized> boolean </UserAnonymized>
              <UserID> UserIDType (string) </UserID>
              <UserIDChanged> boolean </UserIDChanged>
              <UserIDLastChanged> dateTime </UserIDLastChanged>
              <VATStatus> VATStatusCodeType </VATStatus>
            </HighBidder>
            <LeadCount> int </LeadCount>
            <ListingStatus> ListingStatusCodeType </ListingStatus>
            <MinimumToBid currencyID="CurrencyCodeType"> AmountType (double) </MinimumToBid>
            <PromotionalSaleDetails> PromotionalSaleDetailsType
              <EndTime> dateTime </EndTime>
              <OriginalPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalPrice>
              <StartTime> dateTime </StartTime>
            </PromotionalSaleDetails>
            <QuantitySold> int </QuantitySold>
            <ReserveMet> boolean </ReserveMet>
            <SecondChanceEligible> boolean </SecondChanceEligible>
          </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 ... -->
        </Variation>
        <!-- ... more Variation nodes allowed here ... -->
      </Variations>
      <WatchCount> long </WatchCount>
    </Item>
    <!-- ... more Item nodes allowed here ... -->
  </ItemArray>
  <ItemsPerPage> int </ItemsPerPage>
  <PageNumber> int </PageNumber>
  <PaginationResult> PaginationResultType
    <TotalNumberOfEntries> int </TotalNumberOfEntries>
    <TotalNumberOfPages> int </TotalNumberOfPages>
  </PaginationResult>
  <ReturnedItemCountActual> int </ReturnedItemCountActual>
  <Seller> UserType
    <AboutMePage> boolean </AboutMePage>
    <eBayGoodStanding> boolean </eBayGoodStanding>
    <Email> string </Email>
    <FeedbackPrivate> boolean </FeedbackPrivate>
    <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
    <FeedbackScore> int </FeedbackScore>
    <IDVerified> boolean </IDVerified>
    <MotorsDealer> boolean </MotorsDealer>
    <NewUser> boolean </NewUser>
    <RegistrationDate> dateTime </RegistrationDate>
    <SellerInfo> SellerType
      <AllowPaymentEdit> boolean </AllowPaymentEdit>
      <CheckoutEnabled> boolean </CheckoutEnabled>
      <CIPBankAccountStored> boolean </CIPBankAccountStored>
      <GoodStanding> boolean </GoodStanding>
      <MerchandizingPref> MerchandizingPrefCodeType (token) </MerchandizingPref>
      <QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
      <SafePaymentExempt> boolean </SafePaymentExempt>
      <SellereBayPaymentProcessConsent> SellereBayPaymentProcessConsentCodeType
        <PayoutMethod> PayoutMethodType </PayoutMethod>
        <PayoutMethodSet> boolean </PayoutMethodSet>
        <UserAgreementInfo> UserAgreementInfoType
          <AcceptedTime> dateTime </AcceptedTime>
          <SellereBayPaymentProcessEnableTime> dateTime </SellereBayPaymentProcessEnableTime>
          <SellereBayPaymentProcessStatus> SellereBayPaymentProcessStatusCodeType </SellereBayPaymentProcessStatus>
          <Site> SiteCodeType </Site>
          <UserAgreementURL> anyURI </UserAgreementURL>
        </UserAgreementInfo>
        <!-- ... more UserAgreementInfo nodes allowed here ... -->
      </SellereBayPaymentProcessConsent>
      <SellereBayPaymentProcessStatus> SellereBayPaymentProcessStatusCodeType </SellereBayPaymentProcessStatus>
      <SellerLevel> SellerLevelCodeType </SellerLevel>
      <StoreOwner> boolean </StoreOwner>
      <StoreURL> anyURI </StoreURL>
      <TopRatedSeller> boolean </TopRatedSeller>
    </SellerInfo>
    <Site> SiteCodeType </Site>
    <Status> UserStatusCodeType </Status>
    <UserAnonymized> boolean </UserAnonymized>
    <UserID> UserIDType (string) </UserID>
    <UserIDChanged> boolean </UserIDChanged>
    <UserIDLastChanged> dateTime </UserIDLastChanged>
    <VATStatus> VATStatusCodeType </VATStatus>
  </Seller>
  <!-- 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>
</GetSellerListResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
HasMoreItems boolean Conditionally If true, there are more items yet to be retrieved. Additional GetSellerList calls with higher page numbers or more items per page must be made to retrieve these items. Not returned if no items match the request.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray ItemArrayType Always Contains the list of the seller's items, one ItemType object per item. Returns empty if no items are available that match the request.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item ItemType Conditionally,
repeatable: [0..*]
Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request.

Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has an order relationship with that buyer.

For calls that support detail levels, the set of fields returned is also controlled by the value of DetailLevel in the request. For some calls, other parameters in the request can also control the data returned for each item. For example, GranularityLevel controls the fields to return for each item in the GetSellerList response.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ApplicationData string Conditionally Returns custom, application-specific data associated with the item. The data you specify is stored by eBay with the item for your own reference, but it is not used by eBay in any way. Use ApplicationData to store special information for yourself, such as a part number. For a SKU in an eBay.com listing, use the SKU element instead. To remove this value when revising or relisting an item, use DeletedField.

Not applicable to Half.com; use SellerInventoryID instead.
Max length: 32.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.AutoPay boolean Conditionally To create a requirement that a buyer pays immediately (through PayPal or PaisaPay) for an auction (Buy It Now only) or fixed-price item, the seller can include and set the AutoPay field to 'true' for an Add/Revise/Relist API call. If the seller does not want to create an immediate payment item, this field is either omitted, or included and set to 'false'.

If this feature is enabled for a listing, the buyer must pay immediately for the item through PayPal or PaisaPay (India site only), and the buyer's funds are transferred instantly to the seller's PayPal or PaisaPay account. The seller's item will remain available for purchase by other buyers until the buyer actually completes the payment.

In order for a seller to apply an immediate payment requirement for an item, the following must be true:
  • seller must have a Premier or Business PayPal account (or PaisaPay for India sellers);
  • the Buy It Now price (if applicable) cannot be higher than $10,000 USD;
  • the listing site supports PayPal (or PaisaPay for India site) payments;
  • the category supports PayPal (or PaisaPay for India site) payments;
  • the listing type is fixed-price or auction (with Buy It Now option).

To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call:
  • seller must provide a valid Item.PayPalEmailAddress value (not required for India site);
  • seller must offer PayPal as the only payment method, or for the India site, one or more of the three supported PaisaPay payment methods;
  • seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges;
  • seller must include and set the PromotionalShippingDiscount field to true if a promotional shipping discount is being applied to the listing;
  • seller must include the ShippingDiscountProfileID and reference a valid flat or calculated Shipping Discount Profile ID if a flat or calculated shipping rule is being applied to the listing.

In the Trading API calls that return the AutoPay field, be aware that the field's appearance in the output does not necessarily indicate that the immediate payment feature was successfully enabled/used for the active or ended listing, but only that the seller attempted to enable (by including and setting AutoPay to 'true' in the request) the immediate payment feature for the listing.

To discover if a category supports immediate payment for an item, use GetCategories and look for the appearance of the AutoPayEnabled boolean field in the output for that category (identified by CategoryID). AutoPayEnabled is returned as an empty element if the category supports immediate payment, and is not returned at all if the category does not support immediate payment.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    Specifying a Payment Method
    Requiring Immediate Payment of a Vehicle Deposit

ItemArray.Item
  .BuyerGuaranteePrice
AmountType (double) Conditionally For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item
  .BuyerGuaranteePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.BuyerProtection BuyerProtectionCodeType Conditionally Flag to indicate an item's eligibility for the PayPal Purchase Protection program. This field is only returned if 'true'. If this field is not returned, the item is not eligible for PayPal Purchase Protection. For more information on items that are eligible for PayPal Purchase Protection, see the PayPal Purchase Protection help page.

Not applicable to Half.com.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ItemEligible

(out) This value indicates that the item is eligible for buyer protection.

•   ItemIneligible

(out) This value indicates that the item is ineligible for buyer protection. In many cases, the item is ineligible for buyer protection due to the category it is listed under.

•   ItemMarkedEligible

(out) This value indicates that the eBay customer support has marked the item as eligible per special criteria.

•   ItemMarkedIneligible

(out) This value indicates that the eBay customer support has marked the item as ineligible per special criteria (e.g., seller's account closed).

•   NoCoverage

(out) This value indicates that the item is ineligible for coverage under any buyer protection program.




DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See Miscellaneous Item Field Differences.

ItemArray.Item.BuyItNowPrice AmountType (double) Conditionally For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing.

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

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

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

There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user.

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine, Medium.

See:
    Seller Limits
    GeteBayDetails
    Revising US eBay Motors Listings

ItemArray.Item.BuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing.

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

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

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

There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user.

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

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.Charity CharityType Conditionally Identifies a Giving Works listing and the benefiting nonprofit charity organization selected by the charity seller (if any). If specified, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods).

When you revise an item, you can add a charity to a non-charity listing, but you cannot remove or change the charity designation. The rules for adding a charity to a listing depend on the listing type. For an auction listing, you can revise an item to add a charity if there are more than 12 hours left for the listing (whether or not the item has bids). For a fixed-price listing, you can revise an item to add a charity if there are more than 12 hours left for the listing, and the item has not been sold.

When you relist an item, use DeletedField to remove charity information.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    Miscellaneous Item Field Differences
    Working with Listings that Benefit Nonprofits

ItemArray.Item.Charity
  .CharityID
string Conditionally A unique identification number assigned by eBay to registered nonprofit charity organizations. Required input when listing Giving Works items.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Charity
  .CharityListing
boolean Conditionally If true, indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item's purchase price to a selected nonprofit organization.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Charity
  .CharityName
string Conditionally The name of the benefiting nonprofit charity organization selected by the charity seller.
Max length: 150.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Charity
  .CharityNumber
int Conditionally A unique identifier assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. This value can contain up to 10 digits. This value is superseded by CharityID.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Charity
  .DonationPercent
float Conditionally The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is displayed in the Giving Works item listing. Possible values: 10.0 to 100.0. Percentages must increment by 5.0. Minimum donation percentages may be required for Giving Works listings, see http://pages.ebay.com/help/sell/selling-nonprofit.html for details. DonationPercent is required input when listing Giving Works items.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Charity.LogoURL string Conditionally The URL of the nonprofit charity organization. This URL is displayed in the Giving Works item listing.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Charity.Mission string Conditionally The stated mission of the nonprofit charity organization. This mission is displayed in the Giving Works item listing.
Max length: 511.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Charity.Status CharityStatusCodeType Conditionally The status of the nonprofit charity organization.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   NoLongerValid

(out) The specified nonprofit charity organization is no longer a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider.

•   Valid

(out) The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider.




DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .ConditionDescription
string Conditionally This string field is used by the seller to more clearly describe the condition of items that are not brand new.

The ConditionDescription field is available for all categories, including categories where the condition type is not applicable (e.g., Antiques). This field is applicable for all item conditions except "New", "Brand New", "New with tags", and "New in box". If ConditionDescription is used with these conditions (Condition IDs 1000-1499), eBay will simply ignore this field if included, and eBay will return a warning message to the user.

This field should only be used to further clarify the condition of the used item. For example, "The right leg of the chair has a small scratch, and on the seat back there is a light blue stain about the shape and size of a coin." It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the item. Make sure that the condition type (Item.ConditionID), condition description, item description (Item.Description), and the listing's pictures do not contradict one another.

Note: The ConditionDescription field is optional For Add/Revise/Relist API calls. However, this field may become required in some categories starting with the Spring 2013 Seller Release.
ConditionDescription is currently supported on the eBay US and US eBay Motors (0), UK (3), CA (2), CAFR (210), AU (15), AT (16), BEFR (23), BENL (123), FR (71), DE (77), IT (101), NL (146), ES (186), CH (193), IE (205) and PL (212) sites.
The ConditionDescription field is returned by GetItem (and other related calls that return the Item object) if a condition description is specified in the listing.
Max length: 1000.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item
  .ConditionDisplayName
string Conditionally The human-readable label for the item condition. Display names are localized for the site on which they're listed (not necessarily the site on which they're viewed).

Most categories use the same display name for the same condition ID. Some categories may override the display name based on buyer expectations for items in the category. For example, condition ID 1000 could be called "New" in one category and "New with tags" in another.

Behind the scenes, eBay's search engine uses the ID (not the display name) to determine whether items are new, used, or refurbished.

Only returned when the seller specified ConditionID in their listing.
Max length: 50.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ConditionID int Conditionally The numeric ID (e.g., 1000) for the item condition. Sellers should also clarify the item's condition in their own item description.

Note: In addition to including notes on flaws or wear and tear on an used item in the Item.Description, and including a ConditionID value, you can provide additional information about the condition of your used item through the Item.ConditionDescription string field.
For the AddItem family of calls: Use GetCategoryFeatures for details about which categories support (or require) ConditionID, plus policies and help on choosing the right condition for the item (to reduce disputes).

Please note the following behavior if you pass a ConditionID value that is not valid for the category: If ConditionID is disabled (or not applicable) for the category, the item is listed with no condition. If ConditionID is enabled or required for the category, the listing request fails.

If you are listing in two categories, the primary category determines which condition model (ConditionID or item specifics) and which condition values can be used.

US eBay Motors Parts & Accessories and vehicle categories require ConditionID for new listings and re-listings.

Not applicable to Half.com in listing requests (e.g., AddItem). However, ConditionID could be returned in responses for Half.com listings that are available to or sold on the eBay site (as appropriate for the corresponding eBay category).

For Revise/Relist calls: In most cases, you can add or modify ConditionID when you revise or relist. If GetCategoryFeatures returns ConditionEnabled=Required for the listing's category, you cannot remove ConditionID from the listing.

If an auction has bids or ends within 12 hours, you cannot remove or change its condition, and you cannot replace a condition attribute or custom item specific with ConditionID. In this case, you will still be able to modify other fields that are normally editable, even if ConditionID is not present.

In most cases, you can add or modify ConditionID for multi-quantity fixed price listings. (If a multi-quantity fixed price listing has revision restrictions imposed by other choices the seller has made in the listing, you might not be able to remove or change the condition.)

If you revise or relist a GTC listing that only has a condition attribute or custom item specific, you need to specify ConditionID (if the category requires it). ReviseInventoryStatus also fails if you attempt to revise listings that are missing ConditionID. (This rule does not apply during auto-renewal of a GTC listing. It only applies when you perform an action on the listing.)

For GetItem and GetSellerList: Only returned when the seller specified ConditionID in their listing. Also returns a localized display name.

Note: For most categories, eBay does not convert item condition data in the older AttributeSetArray, LookupAttributeArray, or ItemSpecifics format to this format in older listings or when you revise or relist items. This means GTC listings and older ended or sold listings may still return the item condition in these other fields even after new listings only support ConditionID.

There are a few categories in which automatic mapping does occur, where the old and newer conditions are identical. See the "Automatic Mapping" tab in the Item Condition Look-up Table link below for details.

Also, if you specified ConditionID but the category also supports condition in item specifics, you may receive a "Dropped condition from Item specifics" warning. You can ignore this warning as long as you used ConditionID.


DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    Specifying an Item's Condition
    ConditionValues in GetCategoryFeatures
    Item Condition Look-up Table (and Automatic Mapping)

ItemArray.Item.Country CountryCodeType Conditionally Defines the 2-letter country code set.

To see the list of currently supported country codes, and the English names associated with each code (e.g., KY="Cayman Islands"), call GeteBayDetails with DetailName set to CountryDetails, and then look for CountryDetails.Country fields in the response.

Most of the codes that eBay uses conform to the ISO 3166 standard, but some of the codes in the ISO 3166 standard are not used by eBay. Plus, there are some non-ISO codes in the eBay list. (Additional codes appear at the end of this code list and are noted as non-ISO.)

Also applicable as input to AddItem and related calls when you list items to Half.com (specify 'US').

Applicable values: See Country.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse.

See GeteBayDetails.

ItemArray.Item
  .CrossBorderTrade
string Conditionally,
repeatable: [0..*]
This field is used by sellers who want their listing to be returned in the search results for other eBay sites. This feature is currently only supported by the US, UK, eBay Canada, and eBay Ireland sites. See Getting exposure on international sites for full requirements on using this feature. There is a small listing fee for each country specified as a Cross Border Trade country.

US listings that offer shipping to Canada, North America, or worldwide are automatically returned on eBay.ca at no extra charge, so US listings that offer shipping to these locations do not need to specify Canada as a Cross Border Trade country.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See Making Listings Available by Default on Another Site.

ItemArray.Item.Currency CurrencyCodeType Conditionally Currency associated with the item's price information. 3-letter ISO 4217 currency code that corresponds to the site specified in the listing request. Also applicable as input to AddItem and related calls when you list items to Half.com (specify USD). You cannot modify a listing's currency when you revise or relist an item.

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

Applicable values: See Currency.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    GeteBayDetails
    Field Differences for eBay Sites

ItemArray.Item.Description string Conditionally This field is used by the seller to provide a description of the item. In listing requests, you can submit your description using CDATA if you want to use HTML or XML-reserved characters in the description. An error is returned if this contains malicious JavaScript content. (For more information on eBay's HTML and JavaScript policy, see the HTML and JavaScript policy help topic.)

If you embed pictures in the description (by using IMG tags) instead of using PictureURL, but you want a camera icon to appear in search and listing pages, specify the following null-image URL in PictureURL: http://pics.ebay.com/aw/pics/dot_clear.gif. See "Including Pictures in an Item Listing" in the Trading API Guide.

This field is required for all listings except when creating a listing using an eBay catalog product (Item.ProductListingDetails container).

Note: In addition to including notes on flaws or wear and tear on an used item in the Item.Description, and including a ConditionID value, you can provide additional information about the condition of your used item through the Item.ConditionDescription string field.
For GetItem: Item.Description can be empty when IncludePrefilledItemInformation is set to 'true' and the seller did not write their own description. Item.Description doesn't return pre-filled descriptions from catalogs. The eBay site shows the catalog product description (if any) in the product details section of a listing. To retrieve a URL for the catalog product details page, see DetailsURL in FindProducts in the Shopping API.

Not applicable to Half.com. (For Half.com, use AttributeArray.Attribute with the attributeLabel attribute set to 'Notes' to specify a brief description or note to the buyer.)
Max length: 500000 (some sites may allow more, but the exact number may vary).

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .DisableBuyerRequirements
boolean Conditionally If true: all buyer requirements (from Item.BuyerRequirementDetails or Buyer requirements preferences in My eBay) are ignored.

If false (or omitted): Item.BuyerRequirementDetails or Buyer requirements preferences are used, with Item.BuyerRequirementDetails having the higher precedence.
Default: false.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.eBayNowEligible boolean Conditionally This field is used in Add/Revise/Relist calls to enable the listing for eBay Now delivery. To enable the listing for eBay Now delivery, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the eBay Now delivery feature to list an item that is eligible for eBay Now delivery. This field will be ignored if the seller is not eligible to list eBay Now products.

This field will be returned as 'true' in GetSellerList if the item is enabled for eBay Now delivery.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .ExtendedSellerContactDetails
ExtendedContactDetailsType Conditionally Extended contact information for sellers using the Classified Ad format. Specifies the days and hours when the seller can be contacted. To remove seller contact information when revising or relisting an item, use DeletedField.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
ContactHoursDetailsType Conditionally All fields related to contact hours including time ranges and user-designated time zone.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours1AnyTime
boolean Conditionally Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours1Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours1From and Hours1To will be ignored. In the case of this field being false, the values provided Hours1From and Hours1To will be considered.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours1Days
DaysCodeType Conditionally Indicates the range of days for which the primary contact hours specified by Hours1AnyTime or Hours1From and Hours1To apply. If a value of None is provided for this field, the values provided for Hours1AnyTime, Hours1From, Hours1To are ignored.

Applicable values:

•   CustomCode

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

•   EveryDay

(in/out) Seller can be contacted any day during the specified contact hours.

•   None

(in/out) Seller does not want to be contacted. Contact hours will not be supported for any days. If contact hours are specified, they will be ignored.

•   Weekdays

(in/out) Seller can be contacted Monday through Friday during the specified contact hours.

•   Weekends

(in/out) Seller can be contacted Saturday or Sunday during the specified contact hours.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours1From
time Conditionally Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails.Hours1To
time Conditionally Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours2AnyTime
boolean Conditionally Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours2Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours2From and Hours2To will be ignored. In the case of this field being false, the values provided Hours2From and Hours2To will be considered.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours2Days
DaysCodeType Conditionally Indicates the range of days for which the secondary contact hours specified by Hours2AnyTime or Hours2From and Hours2To apply. If a value of None is provided for this field, the values provided for Hours2AnyTime, Hours2From, Hours2To are ignored.
Note: You cannot set Hours2Days to EveryDay. If Hours1Days is set to EveryDay, secondary contact hours do not apply. Hours2Days cannot be set to the same value as Hours1Days.

Applicable values:

•   CustomCode

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

•   EveryDay

(in/out) Seller can be contacted any day during the specified contact hours.

•   None

(in/out) Seller does not want to be contacted. Contact hours will not be supported for any days. If contact hours are specified, they will be ignored.

•   Weekdays

(in/out) Seller can be contacted Monday through Friday during the specified contact hours.

•   Weekends

(in/out) Seller can be contacted Saturday or Sunday during the specified contact hours.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours2From
time Conditionally Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours2Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails.Hours2To
time Conditionally Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .TimeZoneID
string Conditionally Indicates the local time zone of the values provided for Hours1From/Hours1To and Hours2From/Hours2To. If you specify a contact hours time range with Hours1From and Hours1To, you must provide a local time zone. To retrieve a complete list of the TimeZoneID values supported by eBay, call GeteBayDetails with DetailName set to TimeZoneDetails.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .FreeAddedCategory
CategoryType Conditionally ID for a second category that eBay added as a free promotion. You cannot add this yourself. Only returned if the item was listed in a single category and eBay added a free second category.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .FreeAddedCategory.CategoryID
string Conditionally Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID.

For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories.

In an Add/Revise/Relist call, the PrimaryCategory.CategoryID is always required, and the SecondaryCategory.CategoryID is also required if a Secondary Category is used.
Max length: 10.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .FreeAddedCategory
  .CategoryName
string Conditionally Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).

In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings.
Max length: 30.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.GetItFast boolean Conditionally Indicates whether the seller has committed to the GetItFast shipping rules for this listing. If the GetItFast field is set to true, and the seller's first priority domestic shipping service (the service that has the ShippingServicePriority field set to 1) is an expedited shipping service, then every shipping service offered for this listing is considered a GetItFast service. Therefore, the seller commits to delivering the item to the buyer-selected shipping service within one day.
Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

See:
    Enabling Multi-Jurisdiction Sales Tax
    Miscellaneous Item Field Differences

ItemArray.Item.GiftIcon int Conditionally If turned on at listing time, this flag allows the seller to offer one or more gift services to buyers, and a generic gift icon displays next to the listing's title in Search and View Item pages. GiftIcon must be included at listing time and set to '1' to be able to use one or more GiftServices options. The value of '1' indicates that this feature is on, and the value of '0' indicates that the feature is off.

Gift Services are only available on the following eBay sites:
  • Belgium (Dutch)
  • Belgium (French)
  • France
  • Italy
  • Netherlands
  • Poland
  • Spain


To verify if Gift Services are enabled for an eBay site, call , call GeteBayDetails with DetailName set to ListingFeatureDetails. Then look for GiftIcon=Enabled under the ListingFeatureDetails container in the response.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See GeteBayDetails.

ItemArray.Item.HitCount long Conditionally The number of page views for the item. This number is calculated by eBay and cannot be set via the API. Returned if the hit counter type is BasicStyle, RetroStyle, or HiddenStyle. For HiddenStyle, HitCount is returned only if the requestor is the item's seller.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.HitCounter HitCounterCodeType Always Indicates whether an optional hit counter is displayed on the item's listing page and, if so, what type. See HitCounterCodeType for specific values.

Not applicable to Half.com.

Applicable values:

•   BasicStyle

(in/out) A basic style hit counter.

•   CustomCode

(in/out) Reserved for internal or future use

•   GreenLED

(in/out) A green LED, computer-style hit counter (US only). Non-US sites will return errors if they use GreenLED as input, and should use RetroStyle instead.

•   Hidden

(in/out) A hidden hit counter (US only). The number of page views will only be available to the item's seller. For faster "View Item" page loads, use HiddenStyle.

•   HiddenStyle

(in/out) A hidden hit counter. The number of page views will only be available to the item's seller.

•   HonestyStyle

(in/out) A basic style hit counter (US only). Non-US sites will return errors if they use HonestyStyle as input, and should use BasicStyle instead.

•   NoHitCounter

(in/out) No hit counter. The number of page views will not be available.

•   RetroStyle

(in/out) A retro, computer-style hit counter.




DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item
  .IntegratedMerchantCreditCardEnabled
boolean Conditionally Indicates whether the item can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account. A payment gateway account is used by sellers to accept online credit cards (Visa, MasterCard, American Express, and Discover).

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item
  .InventoryTrackingMethod
InventoryTrackingMethodCodeType Conditionally Indicates whether you prefer to track your eBay listings by eBay Item ID or by your own SKU.

If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method.

If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing.
For GetItem and related calls: Only returned when the value is SKU; not returned when the value is ItemID. Not applicable to Half.com.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   ItemID

(in/out) The seller prefers to track the listing by its eBay item ID. This is the default for all listings.

•   SKU

(in/out) The seller prefers to track the listing by their own SKU. When you track by SKU, it means you can pass your SKU instead of the eBay item ID in other calls that support SKU as an input field. If you choose SKU as your tracking preference for a listing, the value in Item.SKU must be unique across your active listings. You cannot create new listings with the same Item.SKU value while the listing is active (that is, until the existing listing with that SKU has ended). However, you can use ReviseInventoryStatus to update the quantity and/or price for the existing SKU as needed. When revising a listing where the InventoryTrackingMethod was set to SKU, you must pass in both the InventoryTrackingMethod tag (with the value set to SKU) and the SKU tag with the SKU value from your original listing.




DetailLevel: ItemReturnDescription, ReturnAll.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

ItemArray.Item.ItemID ItemIDType (string) Conditionally The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value.

Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing.

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

In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem.
Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base.
Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).

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

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item
  .ItemPolicyViolation
ItemPolicyViolationType Conditionally Specifies the details of policy violations if the item was administratively canceled.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .ItemPolicyViolation.PolicyID
long Conditionally Policy ID of the violated policy which resulted in item being administratively canceled.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item
  .ItemPolicyViolation
  .PolicyText
string Conditionally Brief information of the violated policy which resulted in item being administratively canceled.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item
  .ListingCheckoutRedirectPreference
ListingCheckoutRedirectPreferenceType Conditionally Container consisting of the ProStores store name and user name.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .ListingCheckoutRedirectPreference
  .ProStoresStoreName
string Conditionally The name of the ProStores store. To remove this value when revising or relisting an item, use DeletedField.
Max length: 200.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .ListingCheckoutRedirectPreference
  .SellerThirdPartyUsername
string Conditionally The user name of the ProStores store. To remove this value when revising or relisting an item, use DeletedField.
Max length: 200.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ListingDesigner ListingDesignerType Conditionally Contains the detail data for the Listing Designer theme and template (if either are used), which can optionally be used to enhance the appearance of the description area of an item's description. See ListingDesignerType for its child elements.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ListingDesigner
  .LayoutID
int Conditionally Identifies the Layout template to use when displaying the item's description. Call GetDescriptionTemplates for valid IDs. Set to false in GetDescriptionTemplates (or do not specify LayoutID) to get the standard layout. If a Listing Designer layout is used (except standard layout), PhotoDisplayType must be false (or not be specified). When relisting an item, LayoutID is removed from the listing if you specify ListingDesignerType without LayoutID. Alternatively, to remove this value when revising or relisting an item, use DeletedField.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ListingDesigner
  .OptimalPictureSize
boolean Conditionally If true, indicates that the item's picture will be enlarged to fit description of the item.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ListingDesigner
  .ThemeID
int Conditionally ID for the Listing Designer theme template to use when displaying the item's description. When relisting, if you specify ListingDesignerType without ThemeID, ThemeID is removed from the listing. Alternatively, to remove this value when revising or relisting an item, use DeletedField.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ListingDetails ListingDetailsType Conditionally Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria.

Not applicable to Half.com.

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

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ListingDetails
  .Adult
boolean Conditionally If true, the item is listed in a Mature category. Users must accept the Mature Category agreement on the eBay site to retrieve items listed in Mature categories. (Users do not need to sign this agreement to be able to list items in Mature Categories.)

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine, Medium.
ItemArray.Item.ListingDetails
  .BestOfferAutoAcceptPrice
AmountType (double) Conditionally The price at which Best Offers are automatically accepted. Similar in use to MinimumBestOfferPrice. If a buyer submits a Best Offer that is above this value, the offer is automatically accepted by the seller. Applies only to items listed in categories that support the BestOfferAutoAcceptPrice feature. Best Offer must be enabled for the item, and only the seller who listed the item will see BestOfferAutoAcceptPrice in a call response. On the US eBay Motors site (site ID 0), you cannot use the API to add a minimum Best Offer price. For a ReviseItem call on US eBay Motors, prior use of a minimum Best Offer price on eBay.com is ignored.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ListingDetails
  .BestOfferAutoAcceptPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The price at which Best Offers are automatically accepted. Similar in use to MinimumBestOfferPrice. If a buyer submits a Best Offer that is above this value, the offer is automatically accepted by the seller. Applies only to items listed in categories that support the BestOfferAutoAcceptPrice feature. Best Offer must be enabled for the item, and only the seller who listed the item will see BestOfferAutoAcceptPrice in a call response. On the US eBay Motors site (site ID 0), you cannot use the API to add a minimum Best Offer price. For a ReviseItem call on US eBay Motors, prior use of a minimum Best Offer price on eBay.com is ignored.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ListingDetails
  .BindingAuction
boolean Conditionally Applicable for Real Estate auctions only. If true, buyers and sellers are expected to follow through on the sale. If false, bids for the Real Estate auction are only expressions of interest.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine, Medium.
ItemArray.Item.ListingDetails
  .CheckoutEnabled
boolean Conditionally This flag indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled, a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This preferance is enabled by default if PayPal is one of the payment methods.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine, Medium.

See Checkout.

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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine, Medium.
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.
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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
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.
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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
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.
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: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ListingDetails
  .HasPublicMessages
boolean Conditionally Indicates whether the item has any publicly displayed messages. Use GetMemberMessages to retrieve public messages for the item if this flag indicates that there are any.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ListingDetails
  .HasReservePrice
boolean Conditionally If true, the seller specified a value in ReservePrice.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine, Medium.
ItemArray.Item.ListingDetails
  .HasUnansweredQuestions
boolean Conditionally Indicates whether the item has any unanswered questions. Use GetMemberMessages to retrieve unanswered questions for the item if this flag indicates that there are any.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ListingDetails
  .MinimumBestOfferPrice
AmountType (double) Conditionally Specifies the minimum acceptable Best Offer price. If a buyer submits a Best Offer that is below this value, the offer is automatically declined by the seller. Applies only to items listed in categories that support the Best Offer Auto-Decline feature. Best Offer must be enabled for the item, and only the seller who listed the item can see this value. To remove this value when revising or relisting an item, use DeletedField.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ListingDetails
  .MinimumBestOfferPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Specifies the minimum acceptable Best Offer price. If a buyer submits a Best Offer that is below this value, the offer is automatically declined by the seller. Applies only to items listed in categories that support the Best Offer Auto-Decline feature. Best Offer must be enabled for the item, and only the seller who listed the item can see this value. To remove this value when revising or relisting an item, use DeletedField.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ListingDetails
  .RelistedItemID
ItemIDType (string) Conditionally Indicates the new item ID for a re-listed item. When an item is re-listed, the item ID for the new item is added to the old listing, so buyers can navigate to the new listing. This value only appears when the old listing is retrieved. The RelistedItemID of the original item should reflect the last relist.

DetailLevel: ItemReturnDescription, ReturnAll.
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: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ListingDetails
  .TCROriginalItemID
ItemIDType (string) Conditionally Indicates the item ID of the original item listing from which a Transaction Confirmation Request (TCR) was created. This value is only returned when the data for a TCR is retrieved.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ListingDetails
  .ViewItemURL
anyURI Conditionally The URL of the Web page where a user can view the listing. On the US site, this is called the "View Item" page. If you enabled affiliate tracking in a search-related call (for example, if you used the AffiliateTrackingDetails container in an applicable call), ViewItemURL contains a string that includes affiliate tracking information (see the eBay Partner Network).

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ListingDetails
  .ViewItemURLForNaturalSearch
anyURI Conditionally This URL takes you to the same View Item page as ViewItemURL, but this URL is optimized to support natural search. That is, this URL is designed to make items on eBay easier to find via popular Internet search engines. The URL includes the item title along with other optimizations. To note, "?" (question mark) optimizes to "_W0QQ", "&" (ampersand) optimizes to "QQ", and "=" (equals sign) optimizes to "Z".

If you are an eBAy affiliate, use this URL to promote your affiliate information.

Note: This URL may include additional query parameters that don't appear in ViewItemURL and vice versa. You should not modify the query syntax. For example, eBay won't recognize the URL if you change QQ to ?.

DetailLevel: ItemReturnDescription, ReturnAll.
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. To set a duration of 1 day, the seller must have a Feedback score of at least 10.

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.

Required for Half.com (but only specify GTC).

DetailLevel: ItemReturnDescription, ReturnAll.

See:
    GetCategoryFeatures
    Fees per Site



Applicable values: See ListingDurationCodeType
ItemArray.Item
  .ListingEnhancement
ListingEnhancementsCodeType Conditionally,
repeatable: [0..*]
This field can be used by the seller to activate one or more listing upgrades for a listing, such as a Bold Title, a Subtitle, or a Value Pack bundle. A ListingEnhancement field is required for each listing upgrade that the seller wants to activate. There is a small fee associated with each listing upgrade. See the Listing Upgrades help page for more information on the available listing upgrades.

The listing upgrades that are available vary by site and by the seller's account status. To discover which listing upgrades are available, call GeteBayDetails with DetailName set to ListingFeatureDetails and pass in the appropriate SiteID value. Then look for the ListingFeatureDetails container in the response. Listing upgrades will either be listed as 'Enabled' or 'Disabled'.

GetItem (and other calls that retrieve Items) will only return this field if one or more listing upgrades are set for the listing.

You cannot remove listing upgrades when you revise a listing. When you relist an item, use DeletedField to remove a listing upgrade.

Not applicable to Half.com.

Applicable values:

•   BasicUpgradePackBundle

(in/out) No longer applicable to any site.

•   BoldTitle

(in/out) If specified, the seller wants the title for the item's listing to be in boldface type. Applicable listing fees apply. Does not affect the item subtitle (Item.SubTitle), if any. Not applicable to eBay Motors.

•   Border

(in/out) If specified, the seller wants to add a border around the listing's pictures. Applicable listing fees apply.

Note: The Picture Border feature is no longer available on the US site.

•   CustomCode

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

•   Featured

(in/out) Listing is a "Featured Plus" item. The item will display prominently in the Featured Items section of its category list, and it will stand out on search results pages. It will also display in the regular, non- featured item list. Only available to users with a Feedback rating of 10 or greater.

•   Highlight

(in/out) Listing is highlighted in a different color in lists.

•   HomePageFeatured

(in/out) Listing will have a chance to rotate into a special display on eBay's Home page. Your item is very likely to show up on the Home page, although eBay does not guarantee that your item will be highlighted in this way. This is the highest level of visibility on eBay.

Not applicable for eBay Motors. In order to feature the listing on eBay Motors home page, use PictureDetails.GalleryType.Featured instead. See GalleryTypeCodeType for more information.

•   ProPackBundle

(in/out) Listing is using ProPackBundle (a feature pack). Applies only to vehicle listings on eBay Motors (US and Canada), and to the Parts and Accessories category in the eBay Motors US site. Contains the BoldTitle, Border, Featured and Highlight features.

•   ProPackPlusBundle

(in/out) Support for this feature varies by site and category. A ProPackPlusBundle listing is using ProPackPlus bundle (a feature pack), which combines the features of BoldTitle, Border, Highlight, Featured (which is equivalent to a GalleryType value of Featured), and Gallery, for a discounted price. Note that if, for example, in AddItem, if you use ProPackPlusBundle and a GalleryType value of Gallery, then the resulting item will have a GalleryType value of Featured.

•   ValuePackBundle

(in/out) Listing is using ValuePack bundle (a feature pack), which combines the features Gallery, Subtitle, and Listing Designer for a discounted price. Support for this feature varies by site and category.

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

On these sites, whenever ValuePackBundle is selected in a request, the basic Gallery feature included in the Value Pack bundle is automatically upgraded to the Gallery Plus feature at no extra cost (see Item.PictureDetails.GalleryType.Plus for more information on Gallery Plus).

If ValuePackBundle is selected and no Gallery picture is found, the request is still accepted and the ValuePackBundle fee will still apply. Whenever a listing with ValuePackBundle is created on a site that offers free Gallery, the Gallery Plus upgrade will display on all sites and categories that support ValuePackBundle.

Note that if Gallery Showcase is automatically included with Gallery Plus, it will be extended to listings with ValuePackBundle that upgrade Gallery to Gallery Plus (see Item.PictureDetails.GalleryType.Plus for more information on Gallery Plus).




DetailLevel: ItemReturnDescription, ReturnAll.

See GeteBayDetails.

ItemArray.Item.ListingSubtype2 ListingSubtypeCodeType Conditionally Indicates a specific type of lead generation format listing, such as classified ad or local market Best Offer listing. Only applicable when ListingType=LeadGeneration.

Note: ListingSubtype2 replaces the deprecated ListingSubtype field. If both are specified in a request, ListingSubtype2 takes precedence.

Applicable values:

•   ClassifiedAd

(in/out) General classified ad listing subtype.

Note: This value indicates a classified ad (or digital download) listing on ebay.com websites, not on ebayclassifieds.com. The ebayclassifieds.com site is not supported by the Trading API. For information about other differences between these two sites, see Advertising with classified ads on eBay and eBay Classifieds.

•   CustomCode

(in/out) Reserved for internal or future use

•   LocalMarketBestOfferOnly

(in/out) General LocalMarketBestOfferOnly listing subtype.




DetailLevel: ItemReturnDescription, ReturnAll.

See:
    About Local Market Listings
    Advertising with Classified Ads

ItemArray.Item.ListingType ListingTypeCodeType Conditionally The format of the listing the seller wants to use, such as auction style or fixed price.

Optional for eBay.com listings (defaults to auction style) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing.

Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned).



Applicable values:

•   AdType

(in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills in a contact form that eBay forwards to the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings.

•   Chinese

(in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner.

•   CustomCode

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

•   FixedPriceItem

(in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more.

Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for auctions).

Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See 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).

•   LeadGeneration

(in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay).


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


DetailLevel: ItemReturnDescription, ReturnAll.

See:
    Different Ways of Selling
    Listing Types (Formats)
    GetCategoryFeatures
    Fees per Site

ItemArray.Item.Location string Conditionally Indicates the geographical location of the item (along with Country) to be displayed on eBay listing pages. When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours.

If you do not specify Location, you must specify Item.PostalCode.

Note: If you specify both Location and PostalCode, and eBay can determine a location that corresponds to the postal code, the postal code-derived location will be used for the listing. For the Classified Ad format for eBay Motors vehicles, the value provided in the Location is used as item location only if the SellerContactDetails.Street and the SellerContactDetails.Street2 are empty. Else, the SellerContactDetails.Street and the SellerContactDetails.Street2 will be used for item location.

Also applicable as input to AddItem and related calls when you list items to Half.com.
Max length: 45.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item
  .MotorsGermanySearchable
boolean Conditionally If this field is included and set to 'true' for a motor vehicle listing on the Germany site, the seller's motor vehicle listing will also appear on the mobile.de partner site. This field is only applicable to the eBay Germany site and only applicable when listing a motor vehicle on that site. If this field is used in any other situation, it is ignored.

Listing on the mobile.de is considered a listing upgrade so the seller will be charged a listing upgrade fee.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

See Cross-Promoting Vehicles on the Mobile.de Site.

ItemArray.Item
  .OutOfStockControl
boolean Conditionally When this field is set to 'true' the item is hidden from search when the quantity goes to 0 (zero) but the listing is kept alive. Using an OutOfStockControl flag in an Add/Revise/Relist call, a seller can keep a Fixed-Price GTC (Good 'Til Canceled) listing alive even when the "quantity available" value goes to 0 (zero). While the "quantity available" value is 0, the listing would be hidden from eBay search, and if that item was specifically searched for with GetItem (or related call), the element HideFromSearch would be returned as 'true' and ReasonHideFromSearch would be returned as 'OutOfStock'.

This is useful for a seller who is waiting for additional stock of an item with the same ItemID. Instead of ending the listing and then recreating it when the inventory arrives, they can use this flag to hide the listing. Then when they have the item available they can use the Revise calls to update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields) and the listing would appear again.

Using this flag also has the following benifits.
  • Increasing SEO (search engine optimization) -- Since the item is a long running item this increases the chances that it will be indexed by popular search engines.
  • Making merchandizing and inventory management easier
    • Due to the 1:1 mapping of the SKU and ItemID mapping, the merchant doesn't have to refer to multiple ItemIDs to get a count of how much they have in stock, what was sold, etc.
    • Since the listing stays alive, the sales history is retained.
Things to Note:
  • This feature is best suited for Business to Consumer sellers and is available only through the API.
  • OutOfStockControl is set at the item level. So you can set this flag for existing listings using a Revise call and can include it in Add calls.
  • Once this flag is set to 'true' you cannot change it. To remove it, end the item and relist it by setting the OutOfStockControl field to 'false'.
  • When OutOfStockControl is set to 'true', you can set the quantity of the item to zero. When OutOfStockControl is set to 'false' you cannot set the quantity to zero.
  • On a single SKU item, with OutOfStockControl set to 'true' and the quantity is zero, the item does not appear in the SRP (Search Results Page). If a user has the ItemID, they can go to the VIP (View Item Page) directly. On this page, the Buy It Now and Add to cart buttons are gone, and there is a label showing that the item is out of stock.
  • On a multi-SKU item with OutOfStockControl set to 'true', if at least one variation has stock, the item will appear on the SRP. Variations with zero quantity will be shown as 'out of stock' on the VIP. When all of the variations have zero quantity, the item will not appear on the SRP. However, if a user has the ItemID, they can go to the VIP directly. In that case, all the variations are greyed out, the Buy It Now and Add to cart buttons are gone, and there is a label showing that the item is out of stock.
  • Variations: Changing the quantity to zero of variations behaves differently depending on the value of OutOfStockControl. The following shows the behavior when setting the quantity of a variation to zero. In this example there are three variations; A with a quantity of 5, B with a quantity of 3, and C with a quantity of 1 and there have been no sales of any of these variations.

    Variation Quantity Set to 0OutOfStockControl = falseOutOfStockControl = true
    A Variation A is deleted. Variation is retained. Since at least one variation has stock, this variation will show up on the SRP (Search Results Page). On the VIP (View Item Page) it will be shown as 'Out of Stock'.
    B Variation B is deleted. Variation is retained. Since at least one variation has stock, this variation will show up on the SRP. On the VIP it will be shown as 'Out of Stock'.
    C You receive an error because you cannot set the last variation to quantity zero. The variation is retained and all variations will be shown as 'Out of Stock' on the VIP. The item will not appear on the SRP.
  • If you want to delete a variation for an item that has OutOfStockControl set to 'true', you will need to set the Item.Variations.Variation.Delete field to 'true'.


IMPORTANT: When an item is hidden the listing is still alive. That means the Good 'Til Cancelled automatic renewal will continue every 30 days AND the listing fees will be charged. This is best suited for long running items where inventory can be replace in a reasonable time.


Default: false.

See Using the Out-of-Stock Feature.

ItemArray.Item.PaymentMethods BuyerPaymentMethodCodeType Conditionally,
repeatable: [0..*]
Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. For the AddItem family of calls, at least one payment method is required.

Use GetCategoryFeatures to determine the payment methods that are allowed for a category on a site. For example, the response data of GetCategoryFeatures will show that on the US site, most categories only allow electronic payments. Also use GetCategoryFeatures to determine the default payment method for a site (see SiteDefaults.PaymentMethod). If a seller does not include at least one payment method in a Add/Revise/RelistItem API call, the default payment method is used for the listing.

Do not use GeteBayDetails to determine the payment methods for a site.

For a DE or AT seller's items that are subject to the new eBay payment process, only one PaymentMethod field will be returned, and the value will always be 'StandardPayment'.

If you specify multiple PaymentMethods fields, the repeating fields must be contiguous. For example, you can specify PayPalEmailAddress after a list of repeating PaymentMethods fields, but not between them:

<PaymentMethods>VisaMC</PaymentMethods>
<PaymentMethods>PayPal</PaymentMethods>
<PayPalEmailAddress>mypaypalemail@ebay.com</PayPalEmailAddress>

In general, if you separate repeating instances of a field, the results will be unpredictable. This rule applies to all repeating fields (maxOccurs="unbounded" or greater than 1) in the schema. See "Overview of the Schema" in the Trading API Guide.

This field is not applicable to eBay Real Estate Ad format, Classified Ad format, or Half.com listings.

For ReviseItem and RelistItem only: A listing must have at least one valid payment method. When you revise or relist an item and you specify a payment method that is invalid for the target site, eBay ignores the invalid payment method, applies the other valid changes, and returns a warning to indicate that the invalid payment method was ignored. If multiple payment methods were invalid, the warning indicates that they were all ignored. If you modify the listing so that it includes no valid payment methods, an error is returned. This situation could occur when the seller removes all valid payment methods or when all the payment methods specified for the item are no longer valid on the target site.

Applicable values: See PaymentMethods.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See:
    Determining the Payment Methods Allowed for a Category
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences
    Overview of the API Schema
    GeteBayDetails

ItemArray.Item
  .PickupInStoreDetails
PickupInStoreDetailsType Conditionally This container is used in Add/Revise/Relist calls to enable the listing for In-Store Pickup via the EligibleForPickupInStore boolean field. A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup.

In a future release, a fulfillment duration element will be added to this container and will be used to determine when the item will be ready for pickup in a store (immediately, two hours after sale, two days after sale, etc.).

This container is returned in GetSellerList if In-Store Pickup is set for the listing.

Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Sellers who are eligible for the In-Store Pickup feature can start listing items in Production with the In-Store Pickup option beginning in late September 2013. However, in the meantime, merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
ItemArray.Item
  .PickupInStoreDetails
  .EligibleForPickupDropOff
boolean Conditionally This field is used in Add/Revise/Relist calls to enable the listing for the "Click and Collect" feature. To enable the listing for the "Click and Collect" feature, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". At this time, the "Click and Collect" feature is only available to large retail merchants on the eBay UK site (site ID=3).

In addition to setting the EligibleForPickupDropOff boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the "Click and Collect" option on a listing:
  • Have inventory for the product at one or more physical stores tied to the merchant's account.
  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Include the Item.AutoPay flag in the call request and set its value to 'true';
    • Include only one Item.PaymentMethods field in the call request and set its value to 'PayPal';
    • Include a valid PayPal payment address in the Item.PayPalEmailAddress field.


When a UK merchant is successful at listing an item with the "Click and Collect" feature enabled, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item.
ItemArray.Item
  .PickupInStoreDetails
  .EligibleForPickupInStore
boolean Conditionally This field is used in Add/Revise/Relist calls to enable the listing for In-Store Pickup. To enable the listing for In-Store Pickup, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.

In addition to setting the EligibleForPickupInStore boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the In-Store Pickup option on a multi-quantity, fixed-price listing:
  • Have inventory for the product at one or more physical stores tied to the seller's account. By using the REST-based Inventory Management API API, sellers associate physical stores to their account by using the AddInventoryLocation call, and add product inventory to one or more of these stores by using the AddInventory call. For more information on the Inventory Management API, see the In-Store Pickup Users Guide;
  • Include the seller-defined SKU value of the product(s) in the call request. For a single-variation listing, the SKU value would be specified in the Item.SKU field, and for a multi-variation listing, the SKU value(s) would be specified in the Item.Variations.Variation.SKU field(s);
  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Include the Item.AutoPay flag in the call request and set its value to 'true';
    • Include only one Item.PaymentMethods field in the call request and set its value to 'PayPal';
    • Include a valid PayPal payment address in the Item.PayPalEmailAddress field.


When a seller is successful at listing an item with the In-Store Pickup feature enabled, prospective buyers within a reasonable distance (25 miles or so) from one of the seller's stores (that has stock available) will see the "Available for In-Store Pickup" option on the listing, along with information on the closest store that has the item.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.
ItemArray.Item.PictureDetails PictureDetailsType Conditionally Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture.


Not applicable to Half.com.

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

See Introduction to Pictures in Listings.

ItemArray.Item
  .PostCheckoutExperienceEnabled
boolean Conditionally Reserved for future use.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.PrimaryCategory CategoryType Conditionally Category ID for the first (or only) category in which the item is listed (or will be listed, if the item is new). A number of listing features have dependencies on the primary category. We have pointed out a few of the notable dependencies below. See the descriptions of the fields you are using to determine whether the feature you're supporting depends on the listing's primary category.

For the AddItem family of calls: Use calls like GetCategories and GetCategoryFeatures to determine valid values for the site on which you are listing (see the eBay Web Services Guide for information on working with categories). Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill.

There are a number of categories on some eBay sites that always add the Gallery feature (for free) when you include a picture in the listing and you don't specify the Gallery feature yourself. See GalleryType for information about fees that could be charged if you change the category in these cases.

Coming soon: If you list with a catalog product, eBay may drop the primary category you specify and use the category that is associated with the product instead, if different.

Not applicable to Half.com.

For ReviseItem only: When revising a listing, you can change the primary category only if an item has no bids (or no items have sold) and the listing does not end within 12 hours.

Note: For some large merchants, there are no limitations on when the primary or secondary listing categories for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. If you change the listing category, any Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the new category. See Item.AttributeSetArray. For the eBay US site, we suggest that you avoid including a category ID when you list with an external product ID, such as ISBN. See the KB article listed below for details.

You cannot change the meta-categories for vehicles (i.e., you cannot change a truck to a motorcycle), but you can change the leaf category (e.g., change one motorcycle subcategory to another motorcycle subcategory). See the eBay Features Guide for additional information. International sites (such as the eBay Germany site) have similar rules for revising vehicle categories.

When you list an event ticket on the US site, you must specify the Event Tickets category as the primary category. Also, when revising a listing, you cannot change the primary category from another category to the Event Tickets category. (You need to specify the Event Tickets category when you initially list the item.)

For GetItemRecommendations only: For GetItemRecommendations, use this value to control the category that is searched for recommendations. Specify the category in which the item will be listed.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    Applying Categories
    Listing US and CA eBay Motors Items
    (RelistItem) GalleryType

ItemArray.Item.PrimaryCategory
  .CategoryID
string Conditionally Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID.

For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories.

In an Add/Revise/Relist call, the PrimaryCategory.CategoryID is always required, and the SecondaryCategory.CategoryID is also required if a Secondary Category is used.
Max length: 10.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.PrimaryCategory
  .CategoryName
string Conditionally Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).

In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings.
Max length: 30.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.PrivateListing boolean Conditionally The PrivateListing boolean field can be used by the seller in the Add/Relist/Revise family of calls to obscure item title, item ID, and item price from post-order Feedback comments left by buyers. Typically, it is not advisable that sellers use the Private Listing feature, but using this feature may be appropriate for sellers listing in Adults Only categories, or for high-priced and/or celebrity items.

For GetItem, order retrieval calls, and other calls that retrieve the Item object, the PrivateListing field is only returned if 'true'.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ProxyItem boolean Conditionally Some listings on the eBay platform originate from eBay affiliates. Depending on the relationship the affiliate has with eBay, there are times when the affiliate retains ownership of the listing. When this occurs the representation of the listing on eBay is considered a proxy item. Proxy items can only be edited using API requests from the applications that originally listed them.

DetailLevel: ItemReturnDescription, ReturnAll.

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

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

For RelistItem, RelistFixedPriceItem, and VerifyRelistItem: Previously in RelistItem, RelistFixedPriceItem, and VerifyRelistItem the Quantity field retained its value from the previous listing unless you specifically changed it by including the field in a relist call and giving it a new value. And this value was often not accurate with the quantity that was really still available for purchase and it was often out of synch with the QuantityAvailable value that is returned with the GetMyeBaySelling call. As of March 13, 2014, this behavior has been changed in the following manner:
  • For a listing that has ended with an available quantity greater than zero, the Quantity value of the newly relisted item is set to the actual QuantityAvailable value (see the GetMyeBaySelling call) when the previous listing ended.
  • For listings that ended with an available quantity of zero, the relisted item will retain the Quantity value that was passed in at creation time of the previous listing.
So, if you are relisting an item that had an available quantity of zero when the listing ended, we strongly recommend that you pass in the correct available quantity through the 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.

You can set the Quantity to 0 (zero) and keep the listing active if OutOfStockControl is set to 'true'.

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

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

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

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

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

For SetCart input, this is only required if the parent container is submitted.

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

Note: The number in the Quantity field represents the current quantity of items that are available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item 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 items available through each local fulfillment method. In the case where a listing is only offering the item through a local fulfillment method, this value should default to '0', and the Item.IgnoreQuantity will also be returned as 'True'.


DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    Seller Limits
    Selecting a Selling Format

ItemArray.Item
  .QuantityAvailableHint
QuantityAvailableHintCodeType Conditionally Indicates the type of message that will be returned describing the quantity available for the item.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Limited

(out) The message "Limited quantity available" is shown in the web flow (e.g., for a flash sale or a Daily Deal).

•   MoreThan

(out) The message "More than 10 available" is shown in the web flow. 10 is the value of QuantityThreshold tag based on the seller's preference.




DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item
  .QuantityThreshold
int Conditionally The quantity threshold above which the seller prefers not to show the actual quantity available. Returned when the quantity available is greater than the value of quantity threshold. Currently, 10 is the only available value for this threshold.
Default: 10.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReservePrice AmountType (double) Conditionally The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support a reserve price. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the Trading API Guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format 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 and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the Trading API Guide for validation rules when revising US Motors listings.

The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See:
    Revising US eBay Motors Listings
    Reserve Price (eBay Web site help)
    Fees Overview (eBay Web site help)

ItemArray.Item.ReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support a reserve price. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the Trading API Guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format 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 and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the Trading API Guide for validation rules when revising US Motors listings.

The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing.

Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ReturnPolicy ReturnPolicyType Conditionally Container that describes the seller's return policy. Most categories on most eBay sites require the seller to include a return policy through the ReturnPolicy container.

For the AddItem family of calls: Required for most categories on most sites. Use ReturnPolicyEnabled in GetCategoryFeatures to determine which categories require this field. To determine which ReturnPolicy fields can be used on each site, call GeteBayDetails with DetailName set to ReturnPolicyDetails.

eBay India (IN), Australia (AU), and US eBay Motors Parts and Accessories categories typically support but do not require a return policy. (However, we strongly recommend that you specify a clear return policy whenever possible.)

For ReviseItem only: If the listing has bids or sales and it ends within 12 hours, you can't change the return policy details. If the listing is a GTC listing that has sales or ends within 12 hours (one or the other, but not both), you can add a return policy to the GTC listing (but you can't change return policy details if already present). If the listing has no bids or sales and more than 12 hours remain before the listing ends, you can add or change the return policy. When you revise your return policy, you only need to specify the fields you want to add or change. You don't need to specify all the other ReturnPolicy fields again. The other fields will retain their existing settings.

For the GetItem family of calls: Only returned if the site you sent the request to supports the seller's return policy. Typically, the return policy details are only returned when the request is sent to the listing site.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    Offering a Clear Return Policy
    (GetCategoryFeatures) Category.ReturnPolicyEnabled for categories that require a return policy
    (GeteBayDetails) ReturnPolicyDetails for return policy fields that each site reports

ItemArray.Item.ReturnPolicy
  .Description
string Conditionally A detailed explanation of the seller's return policy.

eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML, and avoid character entity references (such as &pound; or &#163;). If you include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character (e.g. £).

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but does not specify this field when listing the item, GetItem returns this as an empty node

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.
Max length: 5000.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See (GeteBayDetails) ReturnPolicyDetails.Description for sites that support this field.

ItemArray.Item.ReturnPolicy
  .EAN
string Conditionally The European Article Number (EAN) associated with the item, if any. To determine if your site supports this field, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for a 'true' value in the ReturnPolicyDetails.EAN field. Only returned if the seller has specified this value in their return policy.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.


DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See (GeteBayDetails) ReturnPolicyDetails.EAN.

ItemArray.Item.ReturnPolicy
  .Refund
string Conditionally Display string that buyer applications can use to present RefundOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the Refund.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use RefundOption instead.)

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReturnPolicy
  .RefundOption
token Conditionally Indicates how the seller will compensate the buyer for a returned item. Use the ReturnPolicy.Description field to explain the policy details (such as how quickly the seller will process the refund, whether the seller must receive the item before processing the refund, and other useful details.).

The RefundOption field is not supported by any of the European sites.

Applicable values: To get the applicable RefundOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.Refund.RefundOption fields in the response.

For Add/Revise/Relist/VerifyAdd API calls): If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this RefundOption field when listing the item, some eBay sites may set a default value (like 'MoneyBack'), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For Revise calls only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

Note: As of version 771, listings created, revised, or relisted on the US site with deprecated RefundOption and/or ReturnsWithinOption values (using Add/Revise/Relist API calls) will be blocked.

For RefundOption, the deprecated values for the US site are MerchandiseCredit and Exchange. Instead of these deprecated values, the seller must offer a MoneyBack or a MoneyBackOrExchange refund option. Consider using the MoneyBackOrExchange option when you have the depth of inventory to support an exchange for a different size, color, or undamaged unit. Otherwise, use the MoneyBack option if you have limited inventory.


DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See (GeteBayDetails) RefundOption.



Applicable values: See RefundOptionsCodeType
ItemArray.Item.ReturnPolicy
  .RestockingFeeValue
token Conditionally Display string that indicates the restocking fee charged by the seller for returned items. This value is directly related to the RestockingFeeValueOption value, with the difference being that applications can use RestockingFeeValue to present the RestockingFeeValueOption value in a more user-friendly format when used in a GUI features such as option buttons or drop-down lists.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReturnPolicy
  .RestockingFeeValueOption
token Conditionally This enumeration value indicates the restocking fee charged by the seller for returned items. In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy.

For Add/Revise/Relist calls: To obtain the list of applicable values, call GeteBayDetails with DetailName set to ReturnPolicyDetails. Then look for the list of restocking fee value options in the ReturnPolicyDetails.RestockingFeeValue container in the response.

For Get calls: The RestockingFeeValue field is directly related to RestockingFeeValueOption, and gives a user-friendly description of the restocking fee policy.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See GeteBayDetails.ReturnPolicyDetails for applicable values for RestockingFeeValueOption.



Applicable values: See RestockingFeeCodeType
ItemArray.Item.ReturnPolicy
  .ReturnsAccepted
string Conditionally Display string that buyer applications can use to present ReturnsAcceptedOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the ReturnsAccepted.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use ReturnsAcceptedOption instead.)

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReturnPolicy
  .ReturnsAcceptedOption
token Conditionally Indicates whether the seller allows the buyer to return the item. This field is required when ReturnPolicy is specified. (If you specify ReturnsNotAccepted, the View Item page may initially show the return policy as unspecified. In a future release, the View Item page will be updated to indicate that returns are not accepted instead.)

All sites support the ability for a seller to not accept returns. If the seller doesn't accept returns, the item must specifically indicate ReturnsNotAccepted. (The return policy cannot be omitted from the item.)

On the eBay UK and Ireland sites, business sellers must accept returns for fixed price items (including auction items with Buy It Now, and any other fixed price formats) when the category requires a return policy. On some European sites (such as eBay Germany (DE)), registered business sellers are required to accept returns. Your application can call GetUser to determine a user's current business seller status.

Note: In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for the item (ReturnsAcceptedOption=ReturnsAccepted) and handling time should be set to zero days (same-day shipping) or one day. The handling time is set through an integer value in the Item.DispatchTimeMax field. Top-Rated listings qualify for the greatest average boost in Best Match and for the 20 percent Final Value Fee discount. For more information on eBay's Top-Rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page.
Applicable values: To get the applicable ReturnsAcceptedOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.ReturnsAccepted.Description fields in the response. ReturnsAcceptedOptionsCodeType defines all the possible values.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    (GeteBayDetails) ReturnsAcceptedOption
    Returns and the Law (UK)



Applicable values: See ReturnsAcceptedOptionsCodeType
ItemArray.Item.ReturnPolicy
  .ReturnsWithin
string Conditionally Display string that buyer applications can use to present ReturnsWithinOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the ReturnsWithin.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use ReturnsWithinOption instead.)

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReturnPolicy
  .ReturnsWithinOption
token Conditionally The buyer can return the item within this period of time from the day they receive the item. Use the ReturnPolicy.Description field to explain the policy details.

Applicable values: To get the applicable ReturnsWithinOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption fields in the response. ReturnsWithinOptionsCodeType defines all the possible values.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this ReturnsWithinOption field when listing the item, some eBay sites may set a default value (like Days_14), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

Note: As of version 771, listings created, revised, or relisted with deprecated RefundOption and/or ReturnsWithinOption values (using Add/Revise/Relist API calls) will be blocked.

For ReturnsWithinOption, the deprecated values are Days_3 and Days_7. Instead of these deprecated values, the seller must offer a 14-day, 30-day, or 60-day return window.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See (GeteBayDetails) ReturnsWithinOption.



Applicable values: See ReturnsWithinOptionsCodeType
ItemArray.Item.ReturnPolicy
  .ShippingCostPaidBy
string Conditionally Display string that buyer applications can use to present ShippingCostPaidByOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the ShippingCostPaidBy.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use ShippingCostPaidByOption instead.)

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReturnPolicy
  .ShippingCostPaidByOption
token Conditionally The party who pays the shipping cost for a returned item. Use the ReturnPolicy.Description field to explain any additional details.

Applicable values: To get the applicable ShippingCostPaidByOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.ShippingCostPaidBy.ShippingCostPaidByOption fields in the response. ShippingCostPaidByOptionsCodeType defines all the possible values.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this ShippingCostPaidByOption field when listing the item, some eBay sites may set a default value (like Buyer), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See (GeteBayDetails) ShippingCostPaidByOption for sites that support this field, and applicable values.



Applicable values: See ShippingCostPaidByOptionsCodeType
ItemArray.Item.ReturnPolicy
  .WarrantyDuration
string Conditionally Display string that buyer applications can use to present WarrantyDurationOption in a more user-friendly format to buyers. For example, For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the WarrantyDuration.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use WarrantyDurationOption instead.)

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReturnPolicy
  .WarrantyDurationOption
token Conditionally The warranty period.

Applicable values: To get the applicable WarrantyDurationOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyDuration. WarrantyDurationOption fields in the response. WarrantyDurationOptionsCodeType defines all the possible values.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyDurationOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See (GeteBayDetails) WarrantyDurationOption.



Applicable values: See WarrantyDurationOptionsCodeType
ItemArray.Item.ReturnPolicy
  .WarrantyOffered
string Conditionally Display string that buyer applications can use to present WarrantyOfferedOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the WarrantyOffered.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use WarrantyOfferedOption instead.)

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReturnPolicy
  .WarrantyOfferedOption
token Conditionally Indicates whether a warranty is offered for the item.

Applicable values: To get the applicable WarrantyOfferedOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyOffered.WarrantyOfferedOption fields in the response. WarrantyOfferedCodeType defines all the possible values.
Note: Only the eBay India site supports this field.
For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyOfferedOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

Note: For the US eBay Motors limited warranty (Short-Term Service Agreement) option, use Item.LimitedWarrantyEligible instead.

For the US eBay Motors "Is There an Existing Warranty?" option, use Item.AttributeSetArray instead.


For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    Warranties (eBay India)
    Guidelines for Creating Legally Compliant Listings (eBay India)
    (GeteBayDetails) WarrantyOfferedOption
    (AddItem) Item.LimitedWarrantyEligible for US eBay Motors Short-Term Service Agreement
    (AddItem) Item.AttributeSetArray for US eBay Motors existing warranty option



Applicable values: See WarrantyOfferedCodeType
ItemArray.Item.ReturnPolicy
  .WarrantyType
string Conditionally Display string that buyer applications can use to present WarrantyTypeOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the WarrantyType.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use WarrantyTypeOption instead.)

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReturnPolicy
  .WarrantyTypeOption
token Conditionally Indicates the source or type of the warranty, if any.

Applicable values: To get the applicable WarrantyTypeOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyType.WarrantyTypeOption fields in the response. WarrantyTypeOptionsCodeType defines all the possible values.
Note: Only the eBay India site supports this field.
For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyTypeOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See (GeteBayDetails) WarrantyTypeOption for sites that support this field, and applicable values.



Applicable values: See WarrantyTypeOptionsCodeType
ItemArray.Item.ReviseStatus ReviseStatusType Conditionally An output value only, indicates whether an item has been revised since the listing became active and, if so, which among a subset of properties have been changed by the revision.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReviseStatus
  .ItemRevised
boolean Conditionally If true, indicates the item was revised since the listing became active. Output only.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .SecondaryCategory
CategoryType Conditionally ID for second category in which the item is listed (also see Item.PrimaryCategory).

For the AddItem family of calls: Listing an item in a second category is optional. Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill.

Not applicable to Half.com.

You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. The Final Value Fee is based on the primary category in which the item is listed. Furthermore, you can list the same item in an eBay Motors Parts & Accessories category and in an eligible eBay category, as long as the primary category is associated with the site on which you are listing. That is, the two categories can be a mix of Motors Parts & Accessories and eBay site categories. (Real Estate, Mature Audience (adult), and Business & Industrial categories are not eligible for listing in two categories in this manner.) For example, if you list on Motors, the primary category could be 6750 (eBay Motors > Parts & Accessories > Apparel & Merchandise > Motorcycle > Jackets & Leathers), and the secondary category could be 57988 (eBay > Clothing, Shoes > Accessories > Men's Clothing > Outerwear). If you list on the main eBay site, the primary category could be 57988 and the secondary category could be 6750.

If eBay has designated a category as a value category (see ValueCategory in GetCategoryFeatures), items in that category cannot be listed in two categories. For example, if your AddItem request includes a primary or secondary category that is a value category, then eBay drops SecondaryCategory and lists the item with only the PrimaryCategory you selected. Also, if the listing request includes item specifics (in ItemSpecifics or AttributeSetArray) that are associated with SecondaryCategory, eBay drops those values when we drop SecondaryCategory. (The same logic is used if you revise an existing listing to add a secondary category or to change one of the categories: If either the primary or secondary category is a value category, eBay drops the secondary category from your request.)

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

For ReviseItem only: When revising a listing, you can add or change the secondary category only if the listing has no bids (or no items have sold) and it does not end within 12 hours. If you change the secondary category, any corresponding Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the category. See Item.AttributeSetArray.

Note: For some large merchants, there are no limitations on when the primary or secondary listing categories for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. When you revise an item, you can change the secondary category from a Motors Parts & Accessories category to an eBay category or vice versa if the listing has no bids (or no items have sold) and it does not end within 12 hours.

For GetItemRecommendations only: For GetItemRecommendations, use this to control the category that will be searched for recommendations. Specify the category in which the item will be listed. See the Trading API Guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attributes engine.

DetailLevel: ItemReturnDescription, ReturnAll.

See Applying Categories.

ItemArray.Item
  .SecondaryCategory.CategoryID
string Conditionally Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID.

For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories.

In an Add/Revise/Relist call, the PrimaryCategory.CategoryID is always required, and the SecondaryCategory.CategoryID is also required if a Secondary Category is used.
Max length: 10.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .SecondaryCategory
  .CategoryName
string Conditionally Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).

In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings.
Max length: 30.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .SellerContactDetails
AddressType Conditionally Contact information for sellers using the Classified Ad format for eBay Motors vehicles categories. To remove seller contact information when revising or relisting an item, use DeletedField. The seller contact details for the primary and secondary phone numbers cannot be deleted individually.

To provide City, State, and Zip code information in SellerContactDetails use the following field:
Item.SellerContactDetails.Street2

To delete the secondary phone number, for example, you must delete all of the secondary phone fields:
Item.SellerContactDetails.Phone2AreaOrCityCode
Item.SellerContactDetails.Phone2CountryCode
Item.SellerContactDetails.Phone2CountryPrefix
Item.SellerContactDetails.Phone2LocalNumber

DetailLevel: ItemReturnDescription, ReturnAll.

See Classified Ad Listings.

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

Business Policies payment profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data.

DetailLevel: ItemReturnDescription, ReturnAll.
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 call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

In the "Get" calls, the PaymentProfileID value will always be returned if the listing is using a Business Policies payment profile, and the PaymentProfileName value will be returned if a name is assigned to the payment profile.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileName
string Conditionally The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

In the "Get" calls, the PaymentProfileID value will always be returned if the listing is using a Business Policies payment profile, and the PaymentProfileName value will be returned if a name is assigned to the payment profile.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SellerProfiles
  .SellerReturnProfile
SellerReturnProfileType Conditionally The SellerReturnProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies return policy profile. Business Policies return policy profiles contain detailed information on the seller's return policy, including the refund option, how many days the buyer has to return the item for a refund, warranty information, and restocking fee (if any).

Business Policies return policy profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SellerProfiles
  .SellerReturnProfile
  .ReturnProfileID
long Conditionally The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

In the "Get" calls, the ReturnProfileID value will always be returned if the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SellerProfiles
  .SellerReturnProfile
  .ReturnProfileName
string Conditionally The name of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

In the "Get" calls, the ReturnProfileID value will always be returned if the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SellerProfiles
  .SellerShippingProfile
SellerShippingProfileType Conditionally The SellerShippingProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies shipping policy profile. Business Policies shipping profiles contain detailed information on domestic and international shipping, including shipping service options, handling time, package handling costs, excluded ship-to locations, and shipping insurance information.

Business Policies shipping profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileID
long Conditionally The unique identifier of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. If both fields are provided and their values don't match, the ShippingProfileID takes precedence.

In the "Get" calls, the ShippingProfileID value will always be returned if the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileName
string Conditionally The name of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. If both fields are provided and their values don't match, the ShippingProfileID takes precedence.

In the "Get" calls, the ShippingProfileID value will always be returned if the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SellingStatus SellingStatusType Conditionally Various details about the current status of the listing, such as the current number of bids and the current high bidder.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .AdminEnded
boolean Conditionally If included in the response as true, indicates that the listing was administratively canceled due to a violation of eBay's listing policies and that the item can be relisted using RelistItem. Note that GetItem returns an error (invalid item ID) in the response if Item.SellingStatus.AdminEnded is true and the requesting user is not the seller of the item.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SellingStatus
  .BidCount
int Conditionally Number of bids placed so far against the auction item.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .BidIncrement
AmountType (double) Conditionally The minimum amount a progressive bid must be above the current high bid to be accepted. This field is only applicable to auction listings. The value of this field will always be '0.00' for Classified Ad and fixed-price listings.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .BidIncrement
  [ attribute currencyID ]
CurrencyCodeType Conditionally The minimum amount a progressive bid must be above the current high bid to be accepted. This field is only applicable to auction listings. The value of this field will always be '0.00' for Classified Ad and fixed-price listings.

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

GranularityLevel: Fine.
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.
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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
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.
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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.AboutMePage
boolean Conditionally If true, indicates that the user has set up an About Me page.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.SellingStatus
  .HighBidder.BuyerInfo
  .ShippingAddress
AddressType Conditionally Contains the shipping address of the buyer. See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.BuyerInfo
  .ShippingAddress.Country
CountryCodeType Conditionally The two-digit code representing the country of the user.

If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.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.

Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.eBayGoodStanding
boolean Conditionally If true, indicates that the user is in good standing with eBay.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.EIASToken
string Conditionally Unique identifier for the user that does not change when the eBay user name is changed. Use when an application needs to associate a new eBay user name with the corresponding eBay user.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.SellingStatus
  .HighBidder.Email
string Conditionally Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

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

ItemArray.Item.SellingStatus
  .HighBidder.FeedbackPrivate
boolean Conditionally Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private.

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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.SellingStatus
  .HighBidder.FeedbackRatingStar
FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

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

•   CustomCode

(out) Reserved for internal or future use.

•   Green

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

•   GreenShooting

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

•   None

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

•   Purple

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

•   PurpleShooting

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

•   Red

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

•   RedShooting

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

•   SilverShooting

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

•   Turquoise

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

•   TurquoiseShooting

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

•   Yellow

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

•   YellowShooting

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




DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.FeedbackScore
int Conditionally The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.SellingStatus
  .HighBidder.IDVerified
boolean Conditionally Indicates whether the user has been verified. For more information about the ID Verify program, see: http://pages.ebay.com/help/policies/identity-idverify.html

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.NewUser
boolean Conditionally If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged).

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.RegistrationDate
dateTime Conditionally Indicates the date the specified user originally registered with eBay.

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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.SellingStatus
  .HighBidder.Site
SiteCodeType Conditionally eBay site the user is registered with.

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.

Applicable values: See Site.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.SellingStatus
  .HighBidder.Status
UserStatusCodeType Conditionally Indicates the user's registration/user status.

Applicable values:

•   AccountOnHold

(out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items

•   Confirmed

(out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category

•   CreditCardVerify

(out) User has completed registration and confirmation, but needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CreditCardVerifyHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CustomCode

(out) Reserved for internal or future use

•   Deleted

(out) Records for the specified user have been deleted

•   Ghost

(out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay

•   Guest

(out) The user is a guest user. The user has not added a password and has not confirmed an email address. The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy. The user has been through the buying flow for a guest; the user has been through checkout using the streamlined Buy-It-Now flow.

•   InMaintenance

(out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status

•   Merged

(out) User record has been merged with another account record for the same user

•   RegistrationCodeMailOut

(out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email

•   Suspended

(out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement

•   TermPending

(out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user

•   Unconfirmed

(out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   UnconfirmedHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending

•   Unknown

(out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem


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


DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.UserAnonymized
boolean Always Indicates whether or not the User container has been made anonymous. If true, some elements in the User container have either been removed, or had their values changed to remove identifying characteristics. If false, all expected elements are returned, and no values are changed.

Since a bidder's user info is anonymous, this tag is returned as false only to the bidder, and to the seller of an item that the user is bidding on. For all other users, this tag is returned as true.

GranularityLevel: Fine.

See Working with Anonymous User Information.

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

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

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

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

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

When bidding on items listed on the the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

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

For PlaceOffer, see also SellingStatus.HighBidder.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.SellingStatus
  .HighBidder.UserIDChanged
boolean Conditionally If true, identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser).

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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.SellingStatus
  .HighBidder.UserIDLastChanged
dateTime Conditionally Date and time the user's data was last changed (in GMT).

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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.SellingStatus
  .HighBidder.VATStatus
VATStatusCodeType Conditionally Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT).

Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   NoVATTax

(out) VAT is not applicable

•   VATExempt

(out) Residence in a country with VAT and user is registered as VAT-exempt

•   VATTax

(out) Residence in a country with VAT and user is not registered as VAT-exempt




DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Value-Added Tax (VAT).

ItemArray.Item.SellingStatus
  .LeadCount
int Conditionally Applicable to Ad type listings only. Indicates how many leads to potential buyers are associated with this item. Returns 0 (zero) for listings in other formats. You must be the seller of the item to retrieve the lead count.

DetailLevel: ReturnAll.
ItemArray.Item.SellingStatus
  .ListingStatus
ListingStatusCodeType Conditionally Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing.

Applicable values:

•   Active

(out) The listing is still active or the listing has ended with a sale but eBay has not completed processing the sale details (e.g., total price and high bidder). A multi-item listing is considered active until all items have winning bids or purchases or the listing ends with at least one winning bid or purchase. If the listing has ended with a sale but this Active status is returned, please allow several minutes for eBay to finish processing the listing.

•   Completed

(out) The listing has closed and eBay has completed processing the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. Although the Final Value Fee (FVF) for FixedPriceItem and StoresFixedPrice items is returned by GetSellerTransactions and GetItemTransactions, all other listing types (excluding Buy It Now purchases) require the listing status to be Completed before the Final Value Fee is returned.

•   Custom

(out) Reserved for internal or future use.

•   CustomCode

(out) Reserved for internal or future use.

•   Ended

(out) The listing has ended. If the listing ended with a sale, eBay has completed processing of the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. However, the final value fee is not yet available.




DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .MinimumToBid
AmountType (double) Conditionally Smallest amount the next bid on the item can be. Returns same value as Item.StartPrice (if no bids have yet been placed) or CurrentPrice plus BidIncrement (if at least one bid has been placed). Only applicable to auction listings. Returns null for fixed-price and Ad type listings.

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .MinimumToBid
  [ attribute currencyID ]
CurrencyCodeType Conditionally Smallest amount the next bid on the item can be. Returns same value as Item.StartPrice (if no bids have yet been placed) or CurrentPrice plus BidIncrement (if at least one bid has been placed). Only applicable to auction listings. Returns null for fixed-price and Ad type listings.

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.
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: ItemReturnDescription, ReturnAll.
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: ItemReturnDescription, ReturnAll.
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: ItemReturnDescription, ReturnAll.
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.
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: ItemReturnDescription, ReturnAll.
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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .SecondChanceEligible
boolean Conditionally Part of the Second Chance Offer feature, indicates whether the seller can extend a second chance offer for the item.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
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 Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout.

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

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

ItemArray.Item.ShippingDetails
  .AllowPaymentEdit
boolean Conditionally This field is no longer returned and has been replaced by the ShippingDetails.PaymentEdited field.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .CalculatedShippingRate
CalculatedShippingRateType Conditionally Details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension and weight and packaging/handling costs. If your call specifies a large-dimension item listed with UPS, see Dimensional Weight limit on UPS shipping services results in failure of shipping calculator.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
AmountType (double) Conditionally Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only.
ItemArray.Item.ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
  [ attribute currencyID ]
CurrencyCodeType Conditionally Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ShippingDetails
  .CalculatedShippingRate
  .OriginatingPostalCode
string Conditionally Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .CalculatedShippingRate
  .PackagingHandlingCosts
AmountType (double) Conditionally Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .CalculatedShippingRate
  .PackagingHandlingCosts
  [ attribute currencyID ]
CurrencyCodeType Conditionally Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ShippingDetails
  .CalculatedShippingRate
  .ShippingIrregular
boolean Conditionally Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .CalculatedShippingRate
  .ShippingPackage
ShippingPackageCodeType Conditionally The nature of the package used to ship the item(s). This is required for calculated shipping only. To get the applicable ShippingPackage values for your site, call GeteBayDetails with DetailName set to ShippingPackageDetails, and then look for the ShippingPackageDetails.ShippingPackage fields in the response.

Applicable values: See ShippingPackage.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .CalculatedShippingRate
  .WeightMajor
MeasureType (decimal) Conditionally WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor>
See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

DetailLevel: ItemReturnDescription, ReturnAll.

See Managing Rate Tables with the API for flat rate shipping that requires this field.

ItemArray.Item.ShippingDetails
  .CalculatedShippingRate
  .WeightMinor
MeasureType (decimal) Conditionally See the definition of WeightMajor.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

Note: When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation (for example, 1 lb, 2 oz is rounded up to 2 lbs).

DetailLevel: ItemReturnDescription, ReturnAll.

See Managing Rate Tables with the API for flat rate shipping that requires this field.

ItemArray.Item.ShippingDetails
  .ExcludeShipToLocation
string Conditionally,
repeatable: [0..*]
Use this field to specify an international country or region, or a special domestic location, such as 'PO Box' (in US) or 'Packstation' (in DE), to where you will not ship the associated item. Repeat this element in the call request for each location that you want to exclude as a shipping destination for your item.

Set ShipToRegistrationCountry to true to have your ExcludeShipToLocation settings applied to your listing. The locations you have excluded display in the Shipping and Handling section of your item listing.

If a buyer's primary ship-to location is a location that you have listed as an excluded ship-to location (or if the buyer does not have a primary ship-to location), they will receive an error message if they attempt to buy or place a bid on your item.

The exclude ship-to location values are eBay regions and countries. To see the valid exclude ship-to locations for a specified site, call GeteBayDetails with DetailName set to ExcludeShippingLocationDetails, and then look for the ExcludeShippingLocationDetails.Location fields in the response. Repeat GeteBayDetails for each site on which you list.

This field works in conjunction with Item.ShipToLocations to create a set of international countries and regions to where you will, and will not, ship. You can list a region in the ShipToLocations field, then exclude specific countries within that region with this field (for example, you can specify Africa in ShipToLocations, yet exclude Chad with a ExcludeShipToLocation setting). In addition, if your ShipToLocations is Worldwide, you can use this field to specify both regions and countries that you want to exclude from your shipping destinations.

You can specify a default set of locations to where you will not ship in My eBay. If you create an Exclude Ship-To List, it is, by default, in effect when you list items. However, if you specify any value in this field on input, it nullifies the default settings in your Exclude Ship-To List. (If you use ExcludeShipToLocation when you list an item, you will need to list all the locations to where you will not ship the associated item, regardless of the default settings in your Exclude Ship-To List.)

Specify NONE in this field to override the default Exclude Ship-To List you might have set up in My eBay and indicate that you do not want to exclude any shipping locations from the respective item listing.

Note: To enable your default Exclude Ship-To List, you must enable Exclude Shipping Locations and Buyer Requirements in your My eBay Site Preferences. For details, see the KnowledgeBase Article HowTo: ExcludeShipToLocation.

DetailLevel: ItemReturnDescription, ReturnAll.

Applicable values: See CountryCodeType, ShippingRegionCodeType
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, the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is False, the seller is responsible for specifying an international shipping service for the listing if desired.

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.

ItemArray.Item.ShippingDetails
  .InsuranceOption
InsuranceOptionCodeType Conditionally Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Optional as input and only allowed if ChangePaymentInstructions is true. If this field is not included in the request, values specified in the InsuranceFee field will be ignored.

Note: Note that sellers are responsible for the items they sell until they safely arrive in their customers' hands, and that offering buyer-paid insurance (either as an optional or required service) infers that the buyer is somehow responsible for the safe delivery of the items they purchase. This notion can reduce buyer confidence in the marketplace and the practice of including buyer- paid shipping insurance in your item listings is discouraged.
This field is only returned if the value is other than NotOffered.

Valid only on the following sites: FR and IT
If you include buyer-paid shipping insurance for an item listed on one of the sites that supports this option, a buyer on a site that does not support buyer-paid shipping insurance can still purchase the item. In these cases, the buyer is responsible for all the shipping insurance terms that have been outlined in the item listing.

Applicable to Half.com

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   IncludedInShippingHandling

(in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost.

•   NotOffered

(in/out) The seller does not offer shipping insurance to the buyer.

•   NotOfferedOnSite

(out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites.

•   Optional

(in/out) The seller offers the buyer the choice of paying for shipping insurance or not.

•   Required

(in/out) The seller requires that the buyer pay for shipping insurance.




DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.ShippingDetails
  .InternationalShippingServiceOption
InternationalShippingServiceOptionsType Conditionally,
repeatable: [0..*]
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions.

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

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

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

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

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

ItemArray.Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingService
token Conditionally An international shipping service being offered by the seller to ship an item to a buyer. For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails. To view the full list of International shipping service options in the response, look for the ShippingService fields in the ShippingServiceDetails containers that contain a InternationalService=true field, as this indicates that the ShippingService value is an International shipping service option. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

For flat and calculated shipping.

DetailLevel: ItemReturnDescription, ReturnAll.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
ItemArray.Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
AmountType (double) Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

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

DetailLevel: ItemReturnDescription, ReturnAll.

See Shipping.

ItemArray.Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

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

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServicePriority
int Conditionally This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to five international shipping services (with five InternationalShippingServiceOption containers), so valid values are 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 5 appears at the bottom of a list of five shipping service options.

This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShipToLocation
string Conditionally,
repeatable: [0..*]
An international location or region to where the item seller will ship the item. Use GeteBayDetails with DetailName set to ShippingLocationDetails to determine which locations are valid per site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields. For the AddItem family of calls, this field is required if any international shipping service is specified.

DetailLevel: ItemReturnDescription, ReturnAll.

See Specifying Locations to Where You Ship.



Applicable values: See CountryCodeType, ShippingRegionCodeType
ItemArray.Item.ShippingDetails
  .PaymentEdited
boolean Conditionally Whether the seller allows the buyer to edit the payment amount for the order. (Sellers enable this property in their My eBay user preferences on the eBay site.)

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .SalesTax
SalesTaxType Conditionally Sales tax details. US and US Motors (site 0) sites only, excluding vehicle listings. Flat and calculated shipping.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Enabling Multi-jurisdiction Sales Tax.

ItemArray.Item.ShippingDetails
  .SalesTax.SalesTaxPercent
float Conditionally Percent of an item's price to be charged as the sales tax for the order. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.ShippingDetails
  .SalesTax.SalesTaxState
string Conditionally State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value.

To see the valid values for your site, call GeteBayDetails with DetailName set to TaxJurisdiction, and then look for the TaxJurisdiction.JurisdictionID fields in the response.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .SalesTax
  .ShippingIncludedInTax
boolean Conditionally (US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.ShippingDetails
  .SellerExcludeShipToLocationsPreference
boolean Conditionally Sellers can set up a global Exclude Ship-To List through their My eBay account. The Exclude Ship-To List defines the countries to where the seller does not ship, by default.

This flag returns true if the Exclude Ship-To List is enabled by the seller for the associated item. If false, the seller's Exclude Ship-To List is either not set up, or it has been overridden by the seller when they listed the item with ExcludeShipToLocation fields.

In the response, ExcludeShipToLocation fields detail the locations to where the seller will not ship the item, regardless of the value returned in this field.

DetailLevel: ItemReturnDescription, ReturnAll.

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

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

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

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

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

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

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

ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ExpeditedService
boolean Conditionally Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .LogisticPlanType
string Conditionally Reserved for internal or future use.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingService
token Conditionally A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

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

For flat and calculated shipping. Also applicable to Half.com (for GetOrders).

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

DetailLevel: ItemReturnDescription, ReturnAll.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only. Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

See Determining Shipping Costs for a Listing.

ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only. Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
AmountType (double) Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

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

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

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

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

Also applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll.

See Determining Shipping Costs for a Listing.

ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

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

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

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

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

Also applicable to Half.com (for GetOrders).

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority
int Conditionally This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
AmountType (double) Conditionally An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMax
int Conditionally The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMin
int Conditionally The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .TaxTable
TaxTableType Conditionally Tax details for a jurisdiction, such as a state or province. If no tax table is associated with the item, a tax table is not returned.

For GetItem, a tax table is returned if it exists when:
- DetailLevel is set to ReturnAll or ItemReturnDescription (in this case, the value of IncludeTaxTable does not matter).
- IncludeTaxTable is set to true and DetailLevel is not set or it is set to ItemReturnAttributes.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ShippingDetails
  .TaxTable.TaxJurisdiction
TaxJurisdictionType Conditionally,
repeatable: [0..*]
Sales tax details for zero or more jurisdictions (states, provinces, etc).

For GetTaxTable: If DetailLevel is not specified, information is returned only for the jurisdictions for which the user provided tax information. If DetailLevel is ReturnAll, tax information is returned for all possible jurisdictions, whether specified by the user or not. ShippingIncludedInTax and SalesTaxPercent are returned, but are empty.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .TaxTable.TaxJurisdiction
  .JurisdictionID
string Conditionally Representative identifier for the jurisdiction. Typically an abbreviation (for example, CA for California).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ShippingDetails
  .TaxTable.TaxJurisdiction
  .SalesTaxPercent
float Conditionally The tax percent to apply for a listing shipped to this jurisdiction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).
For GetTaxTable: this tag has no value if the user's tax table has not been set.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ShippingDetails
  .TaxTable.TaxJurisdiction
  .ShippingIncludedInTax
boolean Conditionally Whether shipping costs are to be part of the base amount that is taxed.
For GetTaxTable: This tag is empty if the user did not previously provide information.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item
  .ShippingPackageDetails
ShipPackageDetailsType Conditionally Container consisting of dimension and size details related to a shipping package in which an item will be sent. The information in this container is applicable if the seller is using calculated shipping or flat rate shipping using shipping rate tables with weight surcharges. This container is only returned in the "Get" calls if specified for the item.
ItemArray.Item
  .ShippingPackageDetails
  .ShippingIrregular
boolean Conditionally Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .ShippingPackageDetails
  .ShippingPackage
ShippingPackageCodeType Conditionally The nature of the package used to ship the item(s). Required for calculated shipping only.

Applicable values: See ShippingPackage.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .ShippingPackageDetails
  .WeightMajor
MeasureType (decimal) Conditionally WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor> See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Required on input when calculated shipping is used.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .ShippingPackageDetails
  .WeightMinor
MeasureType (decimal) Conditionally See the definition of WeightMajor. For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. (When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation for example, 1 lb, 2 oz is rounded up to 2 lbs.)

Required on input when calculated shipping is used.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .ShippingServiceCostOverrideList
ShippingServiceCostOverrideListType Conditionally This container is used when the seller wants to override the flat shipping costs for all domestic and/or all international shipping services defined in the Business Policies shipping profile referenced in the SellerProfiles.SellerShippingProfile.ShippingProfileID field. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services.

A ShippingServiceCostOverrideList.ShippingServiceCostOverride container is required for each domestic and/or international shipping service that is defined in the domesticShippingPolicyInfoService and intlShippingPolicyInfoService containers of the Business Policies shipping profile.

Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each ShippingServiceCostOverrideList.ShippingServiceCostOverride container will not change the shipping costs defined for the same shipping services in the Business Policies shipping profile.
ItemArray.Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
ShippingServiceCostOverrideType Conditionally,
repeatable: [0..*]
A ShippingServiceCostOverride container is required for each domestic and/or international shipping service that is defined in the domesticShippingPolicyInfoService and intlShippingPolicyInfoService containers of the Business Policies shipping profile. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services.

Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each ShippingServiceCostOverride container will not change the shipping costs defined for the same shipping services in the Business Policies shipping profile.

To override the shipping costs for each domestic shipping service in the Business Policies shipping profile, the ShippingServiceType field should be set to 'Domestic', and to override the shipping costs for each international shipping service, the ShippingServiceType field should be set to 'International'. For both domestic and international shipping services, the ShippingServicePriority value should match the sortOrderId value for the matching shipping service in the shipping profile. If any of the domestic and/or international shipping service priorities and shipping service options in the Add/Revise/Relist call and Business Policies shipping profile do not match, an error occurs.

If shipping service cost overrides are used in a listing, the ShippingServiceCostOverride container will be returned in the GetSellerList and GetSellingManagerTemplates calls.
ItemArray.Item
  .ShippingTermsInDescription
boolean Conditionally Indicates whether details about shipping costs and arrangements are specified in the item description.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

See Search Results and Shipping Costs.

ItemArray.Item.ShipToLocations string Conditionally,
repeatable: [0..*]
An international location or region to which the seller is willing to ship, regardless of shipping service. The country of the listing site is added by eBay. Use GeteBayDetails with DetailName set to ShippingLocationDetails to determine which international locations are valid for the site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields.

Omit ShipToLocations if you want to ship only within the country of the listing site. To state that you do not wish to ship at all, set ShipToLocations to None. ReviseItem can add a ShipToLocations. On output, ShipToLocations is the collection of all input item-level ShipToLocations plus international shipping service-level ShipToLocation values.

If you have specified a region to which you will ship (such as Asia), you can use ExcludeShipToLocation to exclude certain countries within that region to where you will not ship (such as Afghanistan).

Not applicable to Half.com.
Max length: length of longest name in ShippingRegionCodeType and CountryCodeType.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    ShipToLocations
    GeteBayDetails



Applicable values: See CountryCodeType, ShippingRegionCodeType
ItemArray.Item.Site SiteCodeType Conditionally The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches, and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing.

When you specify Item.Site in AddItem or AddFixedPriceItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API).

Not applicable to Half.com.

Applicable values: See Site.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    The US and International eBay Sites
    Specifying the Target Site
    Field Differences for eBay Sites

ItemArray.Item.SKU SKUType (string) Conditionally A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. 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.)

A SKU is not required to be unique, when you track listings by their ItemID (the default tracking method). A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs.

If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method.

If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing.

For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier.

Note: The eBay Web site UI 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 GetMyeBaySelling, this is only returned if set.
Not applicable to Half.com.
Max length: 50.

DetailLevel: ItemReturnDescription, ReturnAll.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

ItemArray.Item
  .SkypeContactOption
SkypeContactOptionCodeType Conditionally,
repeatable: [0..*]
Indicates the Skype contact option that the seller and buyer can use to communicate about the listing. For Skype communication to be possible, the SkypeEnabled flag must be included and set to 'true'. The seller must also have a Skype account that is linked with his or her eBay account.

More than one Skype contact option may be specified.

Applicable values:

•   Chat

(in/out) The seller can communicate with the buyer by Skype Chat.

•   CustomCode

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

•   Voice

(in/out) The seller can communicate with the buyer by Skype Voice.




DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SkypeEnabled boolean Conditionally Specifies that Skype-related information is included with an item listing, including, for example, Skype Voice. Skype-related information provides buttons that enable potential buyers to contact sellers through Skype. Information about Skype is available at www.Skype.com. If all of the prerequisites for adding Skype buttons to listings are met (see the eBay Features Guide), you can make communication through Skype available in listings. SkypeEnabled must be true if SkypeID and SkypeContactOption are specified.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SkypeID string Conditionally The Skype name of the seller. Requires that SkypeEnabled is set to true. Available if the seller has a Skype account and has linked it (on the eBay site) with his or her eBay account.

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

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

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

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

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice.

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See:
    Seller Limits
    GeteBayDetails

ItemArray.Item.StartPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

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

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

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

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice.

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

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

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.Storefront StorefrontType Conditionally Contains information related to the item in the context of a seller's eBay Store. Applicable for auction and fixed-price listings listed by eBay Stores sellers.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.Storefront
  .StoreCategory2ID
long Conditionally Unique identifier for the secondary custom category in which to list the item. Set this field to a root-level custom category or a custom category that has no child categories (subcategories).

The system resets the value to 0 (None) in the following cases:
- The values of StoreCategoryID and StoreCategory2ID field are the same
- You specify StoreCategory2ID but not StoreCategoryID


In other words, StoreCategoryID must be set to a valid custom category and be different from StoreCategory2ID.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.Storefront
  .StoreCategoryID
long Conditionally Unique identifier of a primary custom category in which to list the item. A custom category is a category that the seller created in their eBay Store. eBay Store sellers can create up to three levels of custom categories for their stores, but the API only supports root-level categories.

To list an item using the categories in a seller's store, you must set this field to a root-level custom category or a custom category that has no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the 'Other' store category.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.Storefront
  .StoreURL
anyURI Conditionally The URL of the seller's eBay Stores page.

DetailLevel: ItemReturnDescription, ReturnAll.

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

DetailLevel: ItemReturnDescription, ReturnAll.

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

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

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

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

Note: For some large merchants, there are no limitations on when the Item Title for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations.
Max length: 80.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item
  .TotalQuestionCount
long Conditionally The number of questions asked about this item. Applies to eBay Motors Pro applications only.

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

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

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

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

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

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

See Configuring Variations for a Listing.

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

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

See Multi-Variation Listings.

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

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

For RelistFixedPriceItem: Previously in RelistFixedPriceItem, the Variation.Quantity field retained its value from the previous listing unless you specifically changed it by including the field in a relist call and giving it a new value. And this value was often not accurate with the variation quantity that was really still available for purchase. As of March 13, 2014, this behavior has been changed in the following manner:
  • For an item variation that had an available quantity greater than zero 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 zero 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 zero 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, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing.


You can set the Quantity to 0 (zero) and keep the listing active if OutOfStockControl is set to 'true'.
For GetSellerTransactions: See Item.Quantity instead.

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: ItemReturnDescription, ReturnAll.

See Describing Variations in a Listing.

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

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .AdminEnded
boolean Conditionally If included in the response as true, indicates that the listing was administratively canceled due to a violation of eBay's listing policies and that the item can be relisted using RelistItem. Note that GetItem returns an error (invalid item ID) in the response if Item.SellingStatus.AdminEnded is true and the requesting user is not the seller of the item.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .BidCount
int Conditionally Number of bids placed so far against the auction item.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .BidIncrement
AmountType (double) Conditionally The minimum amount a progressive bid must be above the current high bid to be accepted. This field is only applicable to auction listings. The value of this field will always be '0.00' for Classified Ad and fixed-price listings.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .BidIncrement
  [ attribute currencyID ]
CurrencyCodeType Conditionally The minimum amount a progressive bid must be above the current high bid to be accepted. This field is only applicable to auction listings. The value of this field will always be '0.00' for Classified Ad and fixed-price listings.

For a list of possible enumeration values, see CurrencyCodeType.
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.
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.
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.
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.
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).
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.AboutMePage
boolean Conditionally If true, indicates that the user has set up an About Me page.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.BuyerInfo
  .ShippingAddress
AddressType Conditionally Contains the shipping address of the buyer. See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.BuyerInfo
  .ShippingAddress.Country
CountryCodeType Conditionally The two-digit code representing the country of the user.

If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.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.

Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.eBayGoodStanding
boolean Conditionally If true, indicates that the user is in good standing with eBay.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.EIASToken
string Conditionally Unique identifier for the user that does not change when the eBay user name is changed. Use when an application needs to associate a new eBay user name with the corresponding eBay user.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.Email
string Conditionally Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

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

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.FeedbackPrivate
boolean Conditionally Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private.

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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.FeedbackRatingStar
FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

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

•   CustomCode

(out) Reserved for internal or future use.

•   Green

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

•   GreenShooting

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

•   None

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

•   Purple

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

•   PurpleShooting

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

•   Red

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

•   RedShooting

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

•   SilverShooting

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

•   Turquoise

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

•   TurquoiseShooting

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

•   Yellow

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

•   YellowShooting

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




DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.FeedbackScore
int Conditionally The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.IDVerified
boolean Conditionally Indicates whether the user has been verified. For more information about the ID Verify program, see: http://pages.ebay.com/help/policies/identity-idverify.html

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.NewUser
boolean Conditionally If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged).

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.RegistrationDate
dateTime Conditionally Indicates the date the specified user originally registered with eBay.

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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.Site
SiteCodeType Conditionally eBay site the user is registered with.

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.

Applicable values: See Site.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.Status
UserStatusCodeType Conditionally Indicates the user's registration/user status.

Applicable values:

•   AccountOnHold

(out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items

•   Confirmed

(out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category

•   CreditCardVerify

(out) User has completed registration and confirmation, but needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CreditCardVerifyHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CustomCode

(out) Reserved for internal or future use

•   Deleted

(out) Records for the specified user have been deleted

•   Ghost

(out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay

•   Guest

(out) The user is a guest user. The user has not added a password and has not confirmed an email address. The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy. The user has been through the buying flow for a guest; the user has been through checkout using the streamlined Buy-It-Now flow.

•   InMaintenance

(out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status

•   Merged

(out) User record has been merged with another account record for the same user

•   RegistrationCodeMailOut

(out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email

•   Suspended

(out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement

•   TermPending

(out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user

•   Unconfirmed

(out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   UnconfirmedHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending

•   Unknown

(out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem


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


DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.UserAnonymized
boolean Always Indicates whether or not the User container has been made anonymous. If true, some elements in the User container have either been removed, or had their values changed to remove identifying characteristics. If false, all expected elements are returned, and no values are changed.

Since a bidder's user info is anonymous, this tag is returned as false only to the bidder, and to the seller of an item that the user is bidding on. For all other users, this tag is returned as true.

GranularityLevel: Fine.

See Working with Anonymous User Information.

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

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

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

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

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

When bidding on items listed on the the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

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

For PlaceOffer, see also SellingStatus.HighBidder.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.UserIDChanged
boolean Conditionally If true, identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser).

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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.UserIDLastChanged
dateTime Conditionally Date and time the user's data was last changed (in GMT).

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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Working with Anonymous User Information.

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.VATStatus
VATStatusCodeType Conditionally Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT).

Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   NoVATTax

(out) VAT is not applicable

•   VATExempt

(out) Residence in a country with VAT and user is registered as VAT-exempt

•   VATTax

(out) Residence in a country with VAT and user is not registered as VAT-exempt




DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Value-Added Tax (VAT).

ItemArray.Item.Variations
  .Variation.SellingStatus
  .LeadCount
int Conditionally Applicable to Ad type listings only. Indicates how many leads to potential buyers are associated with this item. Returns 0 (zero) for listings in other formats. You must be the seller of the item to retrieve the lead count.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .ListingStatus
ListingStatusCodeType Conditionally Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing.

Applicable values:

•   Active

(out) The listing is still active or the listing has ended with a sale but eBay has not completed processing the sale details (e.g., total price and high bidder). A multi-item listing is considered active until all items have winning bids or purchases or the listing ends with at least one winning bid or purchase. If the listing has ended with a sale but this Active status is returned, please allow several minutes for eBay to finish processing the listing.

•   Completed

(out) The listing has closed and eBay has completed processing the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. Although the Final Value Fee (FVF) for FixedPriceItem and StoresFixedPrice items is returned by GetSellerTransactions and GetItemTransactions, all other listing types (excluding Buy It Now purchases) require the listing status to be Completed before the Final Value Fee is returned.

•   Custom

(out) Reserved for internal or future use.

•   CustomCode

(out) Reserved for internal or future use.

•   Ended

(out) The listing has ended. If the listing ended with a sale, eBay has completed processing of the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. However, the final value fee is not yet available.


ItemArray.Item.Variations
  .Variation.SellingStatus
  .MinimumToBid
AmountType (double) Conditionally Smallest amount the next bid on the item can be. Returns same value as Item.StartPrice (if no bids have yet been placed) or CurrentPrice plus BidIncrement (if at least one bid has been placed). Only applicable to auction listings. Returns null for fixed-price and Ad type listings.

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .MinimumToBid
  [ attribute currencyID ]
CurrencyCodeType Conditionally Smallest amount the next bid on the item can be. Returns same value as Item.StartPrice (if no bids have yet been placed) or CurrentPrice plus BidIncrement (if at least one bid has been placed). Only applicable to auction listings. Returns null for fixed-price and Ad type listings.

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.
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.
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: ItemReturnDescription, ReturnAll.
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: ItemReturnDescription, ReturnAll.
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.
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: ItemReturnDescription, ReturnAll.
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: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
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.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .SecondChanceEligible
boolean Conditionally Part of the Second Chance Offer feature, indicates whether the seller can extend a second chance offer for the item.
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: ItemReturnDescription, ReturnAll.

See Describing Variations in a Listing.

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

See Describing Variations in a Listing.

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

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

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

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

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

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

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

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

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Variations
  .Variation.VariationSpecifics
  .NameValueList.Name
string Conditionally A name in a name/value pair.

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

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Variations
  .Variation.VariationSpecifics
  .NameValueList.Value
string Conditionally,
repeatable: [0..*]
A value associated with the name.

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

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

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.WatchCount long Conditionally The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemsPerPage int Conditionally Indicates the number of items that are being returned per page of data (i.e., per call). Will be the same as the value specified in the Pagination.EntriesPerPage input. Only returned if items are returned.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PageNumber int Conditionally Indicates which page of data was just returned. Will be the same as the value specified in the Pagination.PageNumber input. (If the input is higher than the total number of pages, the call fails with an error.) Only returned if items are returned.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PaginationResult PaginationResultType Always Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PaginationResult
  .TotalNumberOfEntries
int Always 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: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PaginationResult
  .TotalNumberOfPages
int Always 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: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ReturnedItemCountActual int Always Indicates the total number of items returned (i.e., the number of ItemType objects in ItemArray).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Seller UserType Always Indicates the seller whose items are returned. The seller is the eBay member whose UserID was passed in the request. If UserID was not specified, the seller is the user who made the request (identified by eBayAuthToken).

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

GranularityLevel: Fine.
Seller.AboutMePage boolean Always If true, indicates that the user has set up an About Me page.

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

GranularityLevel: Fine.
Seller.eBayGoodStanding boolean Always If true, indicates that the user is in good standing with eBay.

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

GranularityLevel: Fine.
Seller.Email string Conditionally Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

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

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

DetailLevel: ReturnAll.

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

Seller.FeedbackPrivate boolean Always Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private.

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

GranularityLevel: Fine.

See Working with Anonymous User Information.

Seller.FeedbackRatingStar FeedbackRatingStarCodeType Always Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

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

•   CustomCode

(out) Reserved for internal or future use.

•   Green

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

•   GreenShooting

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

•   None

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

•   Purple

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

•   PurpleShooting

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

•   Red

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

•   RedShooting

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

•   SilverShooting

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

•   Turquoise

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

•   TurquoiseShooting

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

•   Yellow

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

•   YellowShooting

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




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

GranularityLevel: Fine.
Seller.FeedbackScore int Always The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

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

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

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

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

GranularityLevel: Fine.

See Working with Anonymous User Information.

Seller.IDVerified boolean Always Indicates whether the user has been verified. For more information about the ID Verify program, see: http://pages.ebay.com/help/policies/identity-idverify.html

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

GranularityLevel: Fine.
Seller.MotorsDealer boolean Conditionally Indicates if item is listed for sale by owner (FSBO) or listed by a dealer. Applies to eBay Motors Pro applications only.

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

GranularityLevel: Fine.
Seller.NewUser boolean Always If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged).

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

GranularityLevel: Fine.
Seller.RegistrationDate dateTime Always Indicates the date the specified user originally registered with eBay.

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

GranularityLevel: Fine.

See Working with Anonymous User Information.

Seller.SellerInfo SellerType Always Contains information about a seller, including listing settings, listing preferences, seller rankings, and seller type.

This field is replaced by the SellerBusinessType field if the user is a business seller with a site ID of 77 (Germany), ID of 3 (UK), ID of 205 (Ireland) or ID of 0 (US Motors).

See SellerType or SellerBusinessCodeType for the child elements.

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

GranularityLevel: Coarse, Fine, Medium.
Seller.SellerInfo
  .AllowPaymentEdit
boolean Always Indicates whether the user as a seller by default allows buyers to edit the total cost of an item (while in checkout). (Sellers enable this property in their My eBay user preferences on the eBay site.)

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

GranularityLevel: Fine.
Seller.SellerInfo
  .CheckoutEnabled
boolean Always This flag indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled, a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This preferance is enabled by default if PayPal is one of the payment methods.

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

GranularityLevel: Fine.
Seller.SellerInfo
  .CIPBankAccountStored
boolean Always If true, this flag indicates that the seller has stored bank account information on file with eBay. A seller must have stored bank account information on file with eBay in order to use 'CashOnPickup' as a payment method (known as 'Pay upon Pickup' on the site). This field is applicable to all eBay sites that support 'CashOnPickup' as a payment method.

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

GranularityLevel: Fine.
Seller.SellerInfo.GoodStanding boolean Always If true, indicates that the user is in good standing with eBay. (One of the requirements for listing a new item with Immediate Payment.)

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

GranularityLevel: Fine.
Seller.SellerInfo
  .MerchandizingPref
MerchandizingPrefCodeType (token) Always Indicates whether the seller participates in the Merchandising Manager feature. If so, the seller can set up rules for cross-promoting items from the seller's store. If not, eBay cross-promotes items as the seller's items are being viewed or purchased.

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

GranularityLevel: Fine.
Seller.SellerInfo
  .QualifiesForB2BVAT
boolean Always Indicates whether the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT.

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

GranularityLevel: Fine.
Seller.SellerInfo
  .SafePaymentExempt
boolean Always If true, the user is currently exempt from the requirement to offer at least one safe payment method (PayPal/PaisaPay or one of the credit cards specified in Item.PaymentMethods) when listing items. This value should only return true for sellers who registered before January 17, 2007. Otherwise, it should return false. This setting overrides both the site and category values for SafePaymentRequired.
Default: false.

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

GranularityLevel: Fine.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
SellereBayPaymentProcessConsentCodeType Conditionally This container is returned to all DE and AT sellers and consists of details of the seller's account status regarding the new eBay payment process. This information includes the seller's payout preferences and whether or not the seller has accepted the supplemental user agreement for the new eBay payment process.

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

GranularityLevel: Coarse, Fine, Medium.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .PayoutMethod
PayoutMethodType Conditionally Enumeration value that indicates the account type that the DE or AT seller has selected as their default seller payout account. Once a DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, that seller must set the default payout account in My eBay preferences. eBay will distribute seller payouts to this account. This field will not be returned if PayoutMethodSet='false'.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

Applicable values:

•   EFT

(out) This value indicates that the seller wants eBay to distribute payouts to their bank account via EFT (Electronic Funds Transfer).

•   MONEYBOOKERS

(out) This value indicates that the seller wants eBay to distribute payouts to their Moneybookers (Skrill) account.

•   PAYPAL

(out) This value indicates that the seller wants eBay to distribute payouts to their PayPal account.




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

GranularityLevel: Coarse, Fine, Medium.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .PayoutMethodSet
boolean Conditionally Flag to indicate whether or not a DE or AT seller has set the payout method type on the account. This field is always returned with the SellereBayPaymentProcessConsent container.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

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

GranularityLevel: Coarse, Fine, Medium.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
UserAgreementInfoType Conditionally,
repeatable: [0..*]
Container consisting of details related to the current status of a DE or AT seller signing the required supplemental user agreement for the new eBay payment process. This container will always be returned to DE and AT sellers and the child values that are returned will be dependent on the current SellereBayPaymentProcessStatus value for the seller's account.

If the seller lists items on both the DE and AT sites, a UserAgreementInfo container will be returned for each site, with the sites being distinguished by the UserAgreementInfo.Site value (either 'Germany' or 'Austria').

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

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

GranularityLevel: Coarse, Fine, Medium.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .AcceptedTime
dateTime Conditionally This timestamp indicates the date on which the DE or AT seller accepted the supplemental user agreement for the new payment process. Unless the UserAgreementInfo.SellereBayPaymentProcessStatus value is 'MustAcceptUA', this value is always returned with UserAgreementInfo container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


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

GranularityLevel: Coarse, Fine, Medium.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .SellereBayPaymentProcessEnableTime
dateTime Conditionally This timestamp indicates the date on which the new eBay payment process was fully enabled (if UserAgreementInfo.SellereBayPaymentProcessStatus='eBayPaymentProcessEnabled') or scheduled to be enabled (if UserAgreementInfo.SellereBayPaymentProcessStatus='AcceptedUA' or 'MustAcceptUA', and the enable date is known by eBay). Unless the eBay payment process enable date is not known for the seller, this value is always returned with UserAgreementInfo container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


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

GranularityLevel: Coarse, Fine, Medium.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .SellereBayPaymentProcessStatus
SellereBayPaymentProcessStatusCodeType Conditionally Enumeration value that indicates whether or not a new DE or AT seller has accepted the supplement user agreement for the new payment process for that site (indicated by the UserAgreementInfo.site value). This value is always returned with the UserAgreementInfo container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


Applicable values:

•   AcceptedUA

(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process, but the new payment process has yet to be fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   CustomCode

(out) Reserved for internal or future use

•   eBayPaymentProcessEnabled

(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process and the new payment process is fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   MustAcceptUA

(out) This value indicates that the DE or AT seller has yet to accept the supplemental user agreement related to the new payment process. If the new payment process has been fully implemented on the seller's account, this seller will be blocked from listing on the DE and AT sites until the user agreement is accepted.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




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

GranularityLevel: Coarse, Fine, Medium.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo.Site
SiteCodeType Conditionally String value that indicates the site to which the supplemental user agreement information pertains. This value is always returned with the UserAgreementInfo container.

Although this value is based on SiteCodeType (which contains many values), the only values that will be returned here are 'Germany' or 'Austria'.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


Applicable values: See Site.

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

GranularityLevel: Coarse, Fine, Medium.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .UserAgreementURL
anyURI Conditionally This is the URL for new eBay payment process supplemental user agreement. This URL is only returned if the UserAgreementInfo.SellereBayPaymentProcessStatus='MustAcceptUA'.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


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

GranularityLevel: Coarse, Fine, Medium.
Seller.SellerInfo
  .SellereBayPaymentProcessStatus
SellereBayPaymentProcessStatusCodeType Conditionally This enumeration value indicates the current status of a DE or AT seller's account related to the new eBay payment process.

'AcceptedUA' is returned if the DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, but that same seller's account is not yet ramped up in the new eBay payment process.

'eBayPaymentProcessEnabled' is returned if the DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, and that same seller's account is ramped up in the new eBay payment process.

'MustAcceptUA' is returned if the DE or AT seller has not accepted the supplemental user agreement for the new eBay payment process. If this is the case, the seller can find the URL to the supplemental user agreement in the SellereBayPaymentProcessConsent.UserAgreementInfo.UserAgreementURL field.

Applicable values:

•   AcceptedUA

(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process, but the new payment process has yet to be fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   CustomCode

(out) Reserved for internal or future use

•   eBayPaymentProcessEnabled

(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process and the new payment process is fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   MustAcceptUA

(out) This value indicates that the DE or AT seller has yet to accept the supplemental user agreement related to the new payment process. If the new payment process has been fully implemented on the seller's account, this seller will be blocked from listing on the DE and AT sites until the user agreement is accepted.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




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

GranularityLevel: Coarse, Fine, Medium.
Seller.SellerInfo.SellerLevel SellerLevelCodeType Always The user's eBay PowerSeller tier. Possible values are enumerated in the SellerLevelCodeType code list. SellerInfo.SellerLevel is no longer returned in the GetUser, GetBidderList, GetSellerList, GetItem, and GetItemTransactions responses for the US, DE/AT/CH, and UK/IE sites, for version 629 and later. If you are using a version older than 629, SellerInfo.SellerLevel will still be returned. Developers should note that SellerInfo.SellerLevel could potentially be removed from other sites as well.

Applicable values:

•   Bronze

(out) Bronze (lowest tier)

•   CustomCode

(out) Reserved for internal or future use

•   Gold

(out) Gold (between Silver and Platinum)

•   None

(out) Not a PowerSeller (eBay has not yet evaluated your PowerSeller status, or you have not chosen to be a member of the PowerSeller program, or you lost your PowerSeller status due to a policy violation.)

•   Platinum

(out) Platinum (between Gold and Titanium)

•   Silver

(out) Silver (between Bronze and Gold)

•   Titanium

(out) Titanium (highest tier)




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

GranularityLevel: Fine.
Seller.SellerInfo.StoreOwner boolean Conditionally Boolean value indicates whether or not the seller is an eBay Store owner.

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

GranularityLevel: Fine.
Seller.SellerInfo.StoreURL anyURI Conditionally The URL for the seller's eBay Store. This field is only returned if the seller is a store owner. To determine if a seller is a Store owner, check for the User.SellerInfo.StoreOwner and a value of true. The eBay Stores domain that is returned in this field is based on the SITEID header that is passed in the request, and not on the user's registration address, as was the case prior to version 757. So, if the seller's registration county is the UK, but a SITEID value of 71 (France) is passed into the call, the eBay Stores domain that is returned would be stores.ebay.fr.

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

GranularityLevel: Fine.
Seller.SellerInfo
  .TopRatedSeller
boolean Conditionally This boolean field indicates if the seller is certified as a Top Rated Seller. To qualify as a Top Rated Seller, a seller must meet the following requirements:
  • 100 or more selling transactions in a one-year period
  • Shipment tracking information provided to the buyer within the specified handling time for at least 90 percent of their listings
This field is returned for the following sites only: US (EBAY-US), Motors (EBAY-MOTOR), AT (EBAY-AT), CH (EBAY-CH), DE (EBAY-DE), IE (EBAY-IE) and UK (EBAY-GB).

On the eBay US site, Top Rated Sellers are eligible to receive a Top Rated Plus seal for their listings. For a Top Rated Seller's listing to qualify as a Top Rated Plus listing, that listing must accept returns and the handling time must be set to one day (DispatchTimeMax=1). Top Rated Plus listings get increased visibility in fixed-price searches and receive a Final Value Fee discount.

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

GranularityLevel: Fine.

See:
    Top Rated Seller Resource Center for more information about how to become a Top Rated Seller and qualify for Top Rated Plus on the eBay US site
    Seller Help Page for more information about how to qualify as a Top Rated Seller on the eBay US, AT, CH, DE, IE and UK sites

Seller.Site SiteCodeType Always eBay site the user is registered with.

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.

Applicable values: See Site.

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

GranularityLevel: Fine.

See Working with Anonymous User Information.

Seller.Status UserStatusCodeType Always Indicates the user's registration/user status.

Applicable values:

•   AccountOnHold

(out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items

•   Confirmed

(out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category

•   CreditCardVerify

(out) User has completed registration and confirmation, but needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CreditCardVerifyHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CustomCode

(out) Reserved for internal or future use

•   Deleted

(out) Records for the specified user have been deleted

•   Ghost

(out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay

•   Guest

(out) The user is a guest user. The user has not added a password and has not confirmed an email address. The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy. The user has been through the buying flow for a guest; the user has been through checkout using the streamlined Buy-It-Now flow.

•   InMaintenance

(out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status

•   Merged

(out) User record has been merged with another account record for the same user

•   RegistrationCodeMailOut

(out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email

•   Suspended

(out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement

•   TermPending

(out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user

•   Unconfirmed

(out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   UnconfirmedHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending

•   Unknown

(out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem


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


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

GranularityLevel: Fine.
Seller.UserAnonymized boolean Always Indicates whether or not the User container has been made anonymous. If true, some elements in the User container have either been removed, or had their values changed to remove identifying characteristics. If false, all expected elements are returned, and no values are changed.

Since a bidder's user info is anonymous, this tag is returned as false only to the bidder, and to the seller of an item that the user is bidding on. For all other users, this tag is returned as true.

GranularityLevel: Fine.

See Working with Anonymous User Information.

Seller.UserID UserIDType (string) Always Unique eBay user ID for the user.

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

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

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

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

When bidding on items listed on the the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

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

For PlaceOffer, see also SellingStatus.HighBidder.

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

GranularityLevel: Fine.

See Working with Anonymous User Information.

Seller.UserIDChanged boolean Always If true, identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser).

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

GranularityLevel: Fine.

See Working with Anonymous User Information.

Seller.UserIDLastChanged dateTime Always Date and time the user's data was last changed (in GMT).

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

GranularityLevel: Fine.

See Working with Anonymous User Information.

Seller.VATStatus VATStatusCodeType Always Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT).

Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   NoVATTax

(out) VAT is not applicable

•   VATExempt

(out) Residence in a country with VAT and user is registered as VAT-exempt

•   VATTax

(out) Residence in a country with VAT and user is not registered as VAT-exempt




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

GranularityLevel: Fine.

See Value-Added Tax (VAT).

Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failure

(out) Request processing failed

•   Success

(out) Request processing succeeded

•   Warning

(out) Request processing completed with warning information being included in the response message


(Not all values in AckCodeType apply to this field.)
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.

Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   RequestError

(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.

•   SystemError

(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.


Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value string Conditionally The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Error

(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.

  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.


See the Compatible Application Check section of the eBay Features Guide for more information.

•   Warning

(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.


Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Back to top

GetSellerList Detail Controls


DetailLevel

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

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

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

Output Field none ItemReturnAttributes ItemReturnDescription ReturnAll
HasMoreItems(Y)-(Y)(Y)
ItemArrayY-YY
ItemArray.Item(Y)-(Y)(Y)
ItemArray.Item.ApplicationData--(Y)(Y)
ItemArray.Item.AutoPay--(Y)(Y)
ItemArray.Item.BuyerGuaranteePrice--(Y)(Y)
ItemArray.Item.BuyerProtection--(Y)(Y)
ItemArray.Item.BuyItNowPrice--(Y)(Y)
ItemArray.Item.Charity--(Y)(Y)
ItemArray.Item.Charity.CharityID--(Y)(Y)
ItemArray.Item.Charity.CharityListing--(Y)(Y)
ItemArray.Item.Charity.CharityName--(Y)(Y)
ItemArray.Item.Charity.CharityNumber--(Y)(Y)
ItemArray.Item.Charity.DonationPercent--(Y)(Y)
ItemArray.Item.Charity.LogoURL--(Y)(Y)
ItemArray.Item.Charity.Mission--(Y)(Y)
ItemArray.Item.Charity.Status--(Y)(Y)
ItemArray.Item.ConditionDescription--(Y)(Y)
ItemArray.Item.ConditionDisplayName--(Y)(Y)
ItemArray.Item.ConditionID--(Y)(Y)
ItemArray.Item.Country--(Y)(Y)
ItemArray.Item.CrossBorderTrade--(Y)(Y)
ItemArray.Item.Currency--(Y)(Y)
ItemArray.Item.Description--(Y)(Y)
ItemArray.Item.DisableBuyerRequirements--(Y)(Y)
ItemArray.Item.eBayNowEligible--(Y)(Y)
ItemArray.Item.ExtendedSellerContactDetails(Y)-(Y)(Y)
ItemArray.Item.ExtendedSellerContactDetails.ContactHoursDetails(Y)-(Y)(Y)
ItemArray.Item.ExtendedSellerContactDetails.ContactHoursDetails
  .Hours1AnyTime
(Y)-(Y)(Y)
ItemArray.Item.ExtendedSellerContactDetails.ContactHoursDetails
  .Hours1Days
(Y)-(Y)(Y)
ItemArray.Item.ExtendedSellerContactDetails.ContactHoursDetails
  .Hours1From
(Y)-(Y)(Y)
ItemArray.Item.ExtendedSellerContactDetails.ContactHoursDetails
  .Hours1To
(Y)-(Y)(Y)
ItemArray.Item.ExtendedSellerContactDetails.ContactHoursDetails
  .Hours2AnyTime
(Y)-(Y)(Y)
ItemArray.Item.ExtendedSellerContactDetails.ContactHoursDetails
  .Hours2Days
(Y)-(Y)(Y)
ItemArray.Item.ExtendedSellerContactDetails.ContactHoursDetails
  .Hours2From
(Y)-(Y)(Y)
ItemArray.Item.ExtendedSellerContactDetails.ContactHoursDetails
  .Hours2To
(Y)-(Y)(Y)
ItemArray.Item.ExtendedSellerContactDetails.ContactHoursDetails
  .TimeZoneID
(Y)-(Y)(Y)
ItemArray.Item.FreeAddedCategory--(Y)(Y)
ItemArray.Item.FreeAddedCategory.CategoryID--(Y)(Y)
ItemArray.Item.FreeAddedCategory.CategoryName--(Y)(Y)
ItemArray.Item.GetItFast--(Y)(Y)
ItemArray.Item.GiftIcon--(Y)(Y)
ItemArray.Item.HitCount--(Y)(Y)
ItemArray.Item.HitCounter--YY
ItemArray.Item.IntegratedMerchantCreditCardEnabled--(Y)(Y)
ItemArray.Item.InventoryTrackingMethod--(Y)(Y)
ItemArray.Item.ItemID(Y)-(Y)(Y)
ItemArray.Item.ItemPolicyViolation--(Y)(Y)
ItemArray.Item.ItemPolicyViolation.PolicyID--(Y)(Y)
ItemArray.Item.ItemPolicyViolation.PolicyText--(Y)(Y)
ItemArray.Item.ListingCheckoutRedirectPreference--(Y)(Y)
ItemArray.Item.ListingCheckoutRedirectPreference
  .ProStoresStoreName
--(Y)(Y)
ItemArray.Item.ListingCheckoutRedirectPreference
  .SellerThirdPartyUsername
--(Y)(Y)
ItemArray.Item.ListingDesigner--(Y)(Y)
ItemArray.Item.ListingDesigner.LayoutID--(Y)(Y)
ItemArray.Item.ListingDesigner.OptimalPictureSize--(Y)(Y)
ItemArray.Item.ListingDesigner.ThemeID--(Y)(Y)
ItemArray.Item.ListingDetails(Y)-(Y)(Y)
ItemArray.Item.ListingDetails.Adult--(Y)(Y)
ItemArray.Item.ListingDetails.BestOfferAutoAcceptPrice--(Y)(Y)
ItemArray.Item.ListingDetails.BindingAuction--(Y)(Y)
ItemArray.Item.ListingDetails.CheckoutEnabled--(Y)(Y)
ItemArray.Item.ListingDetails.ConvertedBuyItNowPrice--(Y)(Y)
ItemArray.Item.ListingDetails.ConvertedReservePrice--(Y)(Y)
ItemArray.Item.ListingDetails.ConvertedStartPrice--(Y)(Y)
ItemArray.Item.ListingDetails.EndTime(Y)-(Y)(Y)
ItemArray.Item.ListingDetails.HasPublicMessages--(Y)(Y)
ItemArray.Item.ListingDetails.HasReservePrice--(Y)(Y)
ItemArray.Item.ListingDetails.HasUnansweredQuestions--(Y)(Y)
ItemArray.Item.ListingDetails.MinimumBestOfferPrice--(Y)(Y)
ItemArray.Item.ListingDetails.RelistedItemID--(Y)(Y)
ItemArray.Item.ListingDetails.StartTime(Y)-(Y)(Y)
ItemArray.Item.ListingDetails.TCROriginalItemID(Y)-(Y)(Y)
ItemArray.Item.ListingDetails.ViewItemURL--(Y)(Y)
ItemArray.Item.ListingDetails.ViewItemURLForNaturalSearch--(Y)(Y)
ItemArray.Item.ListingDuration--(Y)(Y)
ItemArray.Item.ListingEnhancement--(Y)(Y)
ItemArray.Item.ListingSubtype2--(Y)(Y)
ItemArray.Item.ListingType--(Y)(Y)
ItemArray.Item.Location--(Y)(Y)
ItemArray.Item.MotorsGermanySearchable--(Y)(Y)
ItemArray.Item.PaymentMethods--(Y)(Y)
ItemArray.Item.PictureDetails(Y)-(Y)(Y)
ItemArray.Item.PostCheckoutExperienceEnabled--(Y)(Y)
ItemArray.Item.PrimaryCategory--(Y)(Y)
ItemArray.Item.PrimaryCategory.CategoryID--(Y)(Y)
ItemArray.Item.PrimaryCategory.CategoryName--(Y)(Y)
ItemArray.Item.PrivateListing--(Y)(Y)
ItemArray.Item.ProxyItem--(Y)(Y)
ItemArray.Item.Quantity--(Y)(Y)
ItemArray.Item.QuantityAvailableHint--(Y)(Y)
ItemArray.Item.QuantityThreshold--(Y)(Y)
ItemArray.Item.ReservePrice--(Y)(Y)
ItemArray.Item.ReturnPolicy--(Y)(Y)
ItemArray.Item.ReturnPolicy.Description--(Y)(Y)
ItemArray.Item.ReturnPolicy.EAN--(Y)(Y)
ItemArray.Item.ReturnPolicy.Refund--(Y)(Y)
ItemArray.Item.ReturnPolicy.RefundOption--(Y)(Y)
ItemArray.Item.ReturnPolicy.RestockingFeeValue--(Y)(Y)
ItemArray.Item.ReturnPolicy.RestockingFeeValueOption--(Y)(Y)
ItemArray.Item.ReturnPolicy.ReturnsAccepted--(Y)(Y)
ItemArray.Item.ReturnPolicy.ReturnsAcceptedOption--(Y)(Y)
ItemArray.Item.ReturnPolicy.ReturnsWithin--(Y)(Y)
ItemArray.Item.ReturnPolicy.ReturnsWithinOption--(Y)(Y)
ItemArray.Item.ReturnPolicy.ShippingCostPaidBy--(Y)(Y)
ItemArray.Item.ReturnPolicy.ShippingCostPaidByOption--(Y)(Y)
ItemArray.Item.ReturnPolicy.WarrantyDuration--(Y)(Y)
ItemArray.Item.ReturnPolicy.WarrantyDurationOption--(Y)(Y)
ItemArray.Item.ReturnPolicy.WarrantyOffered--(Y)(Y)
ItemArray.Item.ReturnPolicy.WarrantyOfferedOption--(Y)(Y)
ItemArray.Item.ReturnPolicy.WarrantyType--(Y)(Y)
ItemArray.Item.ReturnPolicy.WarrantyTypeOption--(Y)(Y)
ItemArray.Item.ReviseStatus--(Y)(Y)
ItemArray.Item.ReviseStatus.ItemRevised--(Y)(Y)
ItemArray.Item.SecondaryCategory--(Y)(Y)
ItemArray.Item.SecondaryCategory.CategoryID--(Y)(Y)
ItemArray.Item.SecondaryCategory.CategoryName--(Y)(Y)
ItemArray.Item.SellerContactDetails--(Y)(Y)
ItemArray.Item.SellerProfiles.SellerPaymentProfile--(Y)(Y)
ItemArray.Item.SellerProfiles.SellerPaymentProfile
  .PaymentProfileID
--(Y)(Y)
ItemArray.Item.SellerProfiles.SellerPaymentProfile
  .PaymentProfileName
--(Y)(Y)
ItemArray.Item.SellerProfiles.SellerReturnProfile--(Y)(Y)
ItemArray.Item.SellerProfiles.SellerReturnProfile.ReturnProfileID--(Y)(Y)
ItemArray.Item.SellerProfiles.SellerReturnProfile
  .ReturnProfileName
--(Y)(Y)
ItemArray.Item.SellerProfiles.SellerShippingProfile--(Y)(Y)
ItemArray.Item.SellerProfiles.SellerShippingProfile
  .ShippingProfileID
--(Y)(Y)
ItemArray.Item.SellerProfiles.SellerShippingProfile
  .ShippingProfileName
--(Y)(Y)
ItemArray.Item.SellingStatus--(Y)(Y)
ItemArray.Item.SellingStatus.AdminEnded--(Y)(Y)
ItemArray.Item.SellingStatus.BidCount--(Y)(Y)
ItemArray.Item.SellingStatus.BidIncrement--(Y)(Y)
ItemArray.Item.SellingStatus.ConvertedCurrentPrice--(Y)(Y)
ItemArray.Item.SellingStatus.CurrentPrice--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.AboutMePage--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.BuyerInfo--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.BuyerInfo.ShippingAddress--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.BuyerInfo.ShippingAddress
  .Country
--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.BuyerInfo.ShippingAddress
  .PostalCode
--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.eBayGoodStanding--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.EIASToken--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.Email--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.FeedbackPrivate--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.FeedbackRatingStar--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.FeedbackScore--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.IDVerified--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.NewUser--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.RegistrationDate--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.Site--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.Status--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.UserID--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.UserIDChanged--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.UserIDLastChanged--(Y)(Y)
ItemArray.Item.SellingStatus.HighBidder.VATStatus--(Y)(Y)
ItemArray.Item.SellingStatus.LeadCount---(Y)
ItemArray.Item.SellingStatus.ListingStatus--(Y)(Y)
ItemArray.Item.SellingStatus.MinimumToBid--(Y)(Y)
ItemArray.Item.SellingStatus.PromotionalSaleDetails--(Y)(Y)
ItemArray.Item.SellingStatus.PromotionalSaleDetails.EndTime--(Y)(Y)
ItemArray.Item.SellingStatus.PromotionalSaleDetails.OriginalPrice--(Y)(Y)
ItemArray.Item.SellingStatus.PromotionalSaleDetails.StartTime--(Y)(Y)
ItemArray.Item.SellingStatus.QuantitySold--(Y)(Y)
ItemArray.Item.SellingStatus.ReserveMet--(Y)(Y)
ItemArray.Item.SellingStatus.SecondChanceEligible--(Y)(Y)
ItemArray.Item.ShippingDetails--(Y)(Y)
ItemArray.Item.ShippingDetails.AllowPaymentEdit--(Y)(Y)
ItemArray.Item.ShippingDetails.CalculatedShippingRate--(Y)(Y)
ItemArray.Item.ShippingDetails.CalculatedShippingRate
  .OriginatingPostalCode
--(Y)(Y)
ItemArray.Item.ShippingDetails.CalculatedShippingRate
  .PackagingHandlingCosts
--(Y)(Y)
ItemArray.Item.ShippingDetails.CalculatedShippingRate
  .ShippingIrregular
--(Y)(Y)
ItemArray.Item.ShippingDetails.CalculatedShippingRate
  .ShippingPackage
--(Y)(Y)
ItemArray.Item.ShippingDetails.CalculatedShippingRate.WeightMajor--(Y)(Y)
ItemArray.Item.ShippingDetails.CalculatedShippingRate.WeightMinor--(Y)(Y)
ItemArray.Item.ShippingDetails.ExcludeShipToLocation--(Y)(Y)
ItemArray.Item.ShippingDetails.GlobalShipping(Y)(Y)(Y)(Y)
ItemArray.Item.ShippingDetails.InsuranceOption--(Y)(Y)
ItemArray.Item.ShippingDetails.InternationalShippingServiceOption--(Y)(Y)
ItemArray.Item.ShippingDetails.InternationalShippingServiceOption
  .ShippingService
--(Y)(Y)
ItemArray.Item.ShippingDetails.InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
--(Y)(Y)
ItemArray.Item.ShippingDetails.InternationalShippingServiceOption
  .ShippingServiceCost
--(Y)(Y)
ItemArray.Item.ShippingDetails.InternationalShippingServiceOption
  .ShippingServicePriority
--(Y)(Y)
ItemArray.Item.ShippingDetails.InternationalShippingServiceOption
  .ShipToLocation
--(Y)(Y)
ItemArray.Item.ShippingDetails.PaymentEdited--(Y)(Y)
ItemArray.Item.ShippingDetails.SalesTax--(Y)(Y)
ItemArray.Item.ShippingDetails.SalesTax.SalesTaxPercent--(Y)(Y)
ItemArray.Item.ShippingDetails.SalesTax.SalesTaxState--(Y)(Y)
ItemArray.Item.ShippingDetails.SalesTax.ShippingIncludedInTax--(Y)(Y)
ItemArray.Item.ShippingDetails
  .SellerExcludeShipToLocationsPreference
--(Y)(Y)
ItemArray.Item.ShippingDetails.ShippingServiceOptions--(Y)(Y)
ItemArray.Item.ShippingDetails.ShippingServiceOptions
  .ExpeditedService
--(Y)(Y)
ItemArray.Item.ShippingDetails.ShippingServiceOptions
  .ShippingService
--(Y)(Y)
ItemArray.Item.ShippingDetails.ShippingServiceOptions
  .ShippingServiceAdditionalCost
--(Y)(Y)
ItemArray.Item.ShippingDetails.ShippingServiceOptions
  .ShippingServiceCost
--(Y)(Y)
ItemArray.Item.ShippingDetails.ShippingServiceOptions
  .ShippingServicePriority
--(Y)(Y)
ItemArray.Item.ShippingDetails.ShippingServiceOptions
  .ShippingSurcharge
--(Y)(Y)
ItemArray.Item.ShippingDetails.ShippingServiceOptions
  .ShippingTimeMax
--(Y)(Y)
ItemArray.Item.ShippingDetails.ShippingServiceOptions
  .ShippingTimeMin
--(Y)(Y)
ItemArray.Item.ShippingDetails.TaxTable--(Y)(Y)
ItemArray.Item.ShippingDetails.TaxTable.TaxJurisdiction--(Y)(Y)
ItemArray.Item.ShippingDetails.TaxTable.TaxJurisdiction
  .JurisdictionID
(Y)--(Y)
ItemArray.Item.ShippingDetails.TaxTable.TaxJurisdiction
  .SalesTaxPercent
(Y)--(Y)
ItemArray.Item.ShippingDetails.TaxTable.TaxJurisdiction
  .ShippingIncludedInTax
(Y)--(Y)
ItemArray.Item.ShippingPackageDetails.ShippingIrregular--(Y)(Y)
ItemArray.Item.ShippingPackageDetails.ShippingPackage--(Y)(Y)
ItemArray.Item.ShippingPackageDetails.WeightMajor--(Y)(Y)
ItemArray.Item.ShippingPackageDetails.WeightMinor--(Y)(Y)
ItemArray.Item.ShippingTermsInDescription--(Y)(Y)
ItemArray.Item.ShipToLocations--(Y)(Y)
ItemArray.Item.Site--(Y)(Y)
ItemArray.Item.SKU--(Y)(Y)
ItemArray.Item.SkypeContactOption--(Y)(Y)
ItemArray.Item.SkypeEnabled--(Y)(Y)
ItemArray.Item.SkypeID--(Y)(Y)
ItemArray.Item.StartPrice--(Y)(Y)
ItemArray.Item.Storefront--(Y)(Y)
ItemArray.Item.Storefront.StoreCategory2ID--(Y)(Y)
ItemArray.Item.Storefront.StoreCategoryID--(Y)(Y)
ItemArray.Item.Storefront.StoreURL--(Y)(Y)
ItemArray.Item.TimeLeft--(Y)(Y)
ItemArray.Item.Title--(Y)(Y)
ItemArray.Item.TotalQuestionCount--(Y)(Y)
ItemArray.Item.Variations--(Y)(Y)
ItemArray.Item.Variations.Variation--(Y)(Y)
ItemArray.Item.Variations.Variation.Quantity--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .AboutMePage
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .BuyerInfo
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .BuyerInfo.ShippingAddress
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .BuyerInfo.ShippingAddress.Country
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .BuyerInfo.ShippingAddress.PostalCode
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .eBayGoodStanding
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .EIASToken
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .Email
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .FeedbackPrivate
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .FeedbackRatingStar
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .FeedbackScore
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .IDVerified
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .NewUser
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .RegistrationDate
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder.Site--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .Status
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .UserID
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .UserIDChanged
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .UserIDLastChanged
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .VATStatus
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus
  .PromotionalSaleDetails.EndTime
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus
  .PromotionalSaleDetails.OriginalPrice
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus
  .PromotionalSaleDetails.StartTime
--(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.QuantitySold--(Y)(Y)
ItemArray.Item.Variations.Variation.SKU--(Y)(Y)
ItemArray.Item.Variations.Variation.StartPrice--(Y)(Y)
ItemArray.Item.Variations.Variation.VariationSpecifics--(Y)(Y)
ItemArray.Item.Variations.Variation.VariationSpecifics
  .NameValueList
--(Y)(Y)
ItemArray.Item.Variations.Variation.VariationSpecifics
  .NameValueList.Name
--(Y)(Y)
ItemArray.Item.Variations.Variation.VariationSpecifics
  .NameValueList.Value
--(Y)(Y)
ItemArray.Item.WatchCount--(Y)(Y)
ItemsPerPage(Y)-(Y)(Y)
PageNumber(Y)-(Y)(Y)
PaginationResultY-YY
PaginationResult.TotalNumberOfEntriesY-YY
PaginationResult.TotalNumberOfPagesY-YY
ReturnedItemCountActualY-YY
SellerY-YY
Seller.AboutMePageY-YY
Seller.eBayGoodStandingY-YY
Seller.Email---(Y)
Seller.FeedbackPrivateY-YY
Seller.FeedbackRatingStarY-YY
Seller.FeedbackScoreY-YY
Seller.IDVerifiedY-YY
Seller.MotorsDealer(Y)-(Y)(Y)
Seller.NewUserY-YY
Seller.RegistrationDateY-YY
Seller.SellerInfoY-YY
Seller.SellerInfo.AllowPaymentEditY-YY
Seller.SellerInfo.CheckoutEnabledY-YY
Seller.SellerInfo.CIPBankAccountStoredY-YY
Seller.SellerInfo.GoodStandingY-YY
Seller.SellerInfo.MerchandizingPrefY-YY
Seller.SellerInfo.QualifiesForB2BVATY-YY
Seller.SellerInfo.SafePaymentExemptY-YY
Seller.SellerInfo.SellereBayPaymentProcessConsent(Y)-(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent.PayoutMethod(Y)-(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent.PayoutMethodSet(Y)-(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo
(Y)-(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.AcceptedTime
(Y)-(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.SellereBayPaymentProcessEnableTime
(Y)-(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.SellereBayPaymentProcessStatus
(Y)-(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.Site
(Y)-(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.UserAgreementURL
(Y)-(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessStatus(Y)-(Y)(Y)
Seller.SellerInfo.SellerLevelY-YY
Seller.SellerInfo.StoreOwner(Y)-(Y)(Y)
Seller.SellerInfo.StoreURL(Y)-(Y)(Y)
Seller.SellerInfo.TopRatedSeller(Y)-(Y)(Y)
Seller.SiteY-YY
Seller.StatusY-YY
Seller.UserIDY-YY
Seller.UserIDChangedY-YY
Seller.UserIDLastChangedY-YY
Seller.VATStatusY-YY


GranularityLevel

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

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

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

Output Field Coarse Fine Medium
ItemArray.Item.ApplicationData(Y)(Y)(Y)
ItemArray.Item.AutoPay(Y)(Y)(Y)
ItemArray.Item.BuyerGuaranteePrice(Y)(Y)(Y)
ItemArray.Item.BuyerProtection(Y)(Y)(Y)
ItemArray.Item.BuyItNowPrice-(Y)(Y)
ItemArray.Item.Charity(Y)(Y)(Y)
ItemArray.Item.ConditionDescription(Y)(Y)(Y)
ItemArray.Item.ConditionDisplayName(Y)(Y)(Y)
ItemArray.Item.ConditionID(Y)(Y)(Y)
ItemArray.Item.Country(Y)--
ItemArray.Item.CrossBorderTrade(Y)(Y)(Y)
ItemArray.Item.Currency(Y)(Y)(Y)
ItemArray.Item.GiftIcon(Y)(Y)(Y)
ItemArray.Item.HitCount(Y)(Y)(Y)
ItemArray.Item.HitCounterYYY
ItemArray.Item.IntegratedMerchantCreditCardEnabled-(Y)-
ItemArray.Item.ItemID(Y)(Y)(Y)
ItemArray.Item.ItemPolicyViolation.PolicyID-(Y)-
ItemArray.Item.ItemPolicyViolation.PolicyText-(Y)-
ItemArray.Item.ListingDetails(Y)(Y)(Y)
ItemArray.Item.ListingDetails.Adult-(Y)(Y)
ItemArray.Item.ListingDetails.BindingAuction-(Y)(Y)
ItemArray.Item.ListingDetails.CheckoutEnabled-(Y)(Y)
ItemArray.Item.ListingDetails.ConvertedBuyItNowPrice-(Y)(Y)
ItemArray.Item.ListingDetails.ConvertedReservePrice-(Y)-
ItemArray.Item.ListingDetails.ConvertedStartPrice-(Y)-
ItemArray.Item.ListingDetails.HasReservePrice-(Y)(Y)
ItemArray.Item.Location(Y)(Y)(Y)
ItemArray.Item.PaymentMethods-(Y)-
ItemArray.Item.PrimaryCategory(Y)(Y)(Y)
ItemArray.Item.ProxyItem(Y)(Y)(Y)
ItemArray.Item.Quantity(Y)(Y)(Y)
ItemArray.Item.QuantityAvailableHint(Y)(Y)(Y)
ItemArray.Item.QuantityThreshold(Y)(Y)(Y)
ItemArray.Item.ReservePrice-(Y)-
ItemArray.Item.ReturnPolicy(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.Description(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.EAN(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.Refund(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.RefundOption(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.RestockingFeeValue(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.RestockingFeeValueOption(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.ReturnsAccepted(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.ReturnsAcceptedOption(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.ReturnsWithin(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.ReturnsWithinOption(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.ShippingCostPaidBy(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.ShippingCostPaidByOption(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.WarrantyDuration(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.WarrantyDurationOption(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.WarrantyOffered(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.WarrantyOfferedOption(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.WarrantyType(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.WarrantyTypeOption(Y)(Y)(Y)
ItemArray.Item.ReviseStatus(Y)(Y)(Y)
ItemArray.Item.SellingStatus-(Y)-
ItemArray.Item.SellingStatus.BidCount-(Y)-
ItemArray.Item.SellingStatus.BidIncrement-(Y)-
ItemArray.Item.SellingStatus.ConvertedCurrentPrice-(Y)-
ItemArray.Item.SellingStatus.CurrentPrice-(Y)-
ItemArray.Item.SellingStatus.HighBidder-(Y)-
ItemArray.Item.SellingStatus.HighBidder.AboutMePage-(Y)-
ItemArray.Item.SellingStatus.HighBidder.BuyerInfo-(Y)-
ItemArray.Item.SellingStatus.HighBidder.BuyerInfo.ShippingAddress-(Y)-
ItemArray.Item.SellingStatus.HighBidder.BuyerInfo.ShippingAddress
  .Country
-(Y)-
ItemArray.Item.SellingStatus.HighBidder.BuyerInfo.ShippingAddress
  .PostalCode
-(Y)-
ItemArray.Item.SellingStatus.HighBidder.eBayGoodStanding-(Y)-
ItemArray.Item.SellingStatus.HighBidder.EIASToken-(Y)-
ItemArray.Item.SellingStatus.HighBidder.FeedbackPrivate-(Y)-
ItemArray.Item.SellingStatus.HighBidder.FeedbackRatingStar-(Y)-
ItemArray.Item.SellingStatus.HighBidder.FeedbackScore-(Y)-
ItemArray.Item.SellingStatus.HighBidder.IDVerified-(Y)-
ItemArray.Item.SellingStatus.HighBidder.NewUser-(Y)-
ItemArray.Item.SellingStatus.HighBidder.RegistrationDate-(Y)-
ItemArray.Item.SellingStatus.HighBidder.Site-(Y)-
ItemArray.Item.SellingStatus.HighBidder.Status-(Y)-
ItemArray.Item.SellingStatus.HighBidder.UserAnonymized-Y-
ItemArray.Item.SellingStatus.HighBidder.UserID-(Y)-
ItemArray.Item.SellingStatus.HighBidder.UserIDChanged-(Y)-
ItemArray.Item.SellingStatus.HighBidder.UserIDLastChanged-(Y)-
ItemArray.Item.SellingStatus.HighBidder.VATStatus-(Y)-
ItemArray.Item.SellingStatus.ListingStatus-(Y)-
ItemArray.Item.SellingStatus.MinimumToBid-(Y)-
ItemArray.Item.SellingStatus.QuantitySold-(Y)-
ItemArray.Item.SellingStatus.ReserveMet-(Y)-
ItemArray.Item.SellingStatus.SecondChanceEligible-(Y)-
ItemArray.Item.ShippingDetails(Y)(Y)(Y)
ItemArray.Item.ShippingDetails.InsuranceOption-(Y)-
ItemArray.Item.ShippingDetails.SalesTax-(Y)-
ItemArray.Item.ShippingDetails.SalesTax.SalesTaxPercent-(Y)-
ItemArray.Item.ShippingDetails.SalesTax.ShippingIncludedInTax-(Y)-
ItemArray.Item.ShippingDetails
  .SellerExcludeShipToLocationsPreference
-(Y)-
ItemArray.Item.ShippingDetails.TaxTable(Y)(Y)(Y)
ItemArray.Item.ShipToLocations(Y)(Y)(Y)
ItemArray.Item.Site(Y)(Y)(Y)
ItemArray.Item.StartPrice-(Y)-
ItemArray.Item.Storefront(Y)(Y)(Y)
ItemArray.Item.Storefront.StoreCategory2ID(Y)(Y)(Y)
ItemArray.Item.Storefront.StoreCategoryID(Y)(Y)(Y)
ItemArray.Item.Storefront.StoreURL(Y)(Y)(Y)
ItemArray.Item.TimeLeft(Y)(Y)(Y)
ItemArray.Item.Title(Y)(Y)(Y)
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .AboutMePage
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .BuyerInfo
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .BuyerInfo.ShippingAddress
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .BuyerInfo.ShippingAddress.Country
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .BuyerInfo.ShippingAddress.PostalCode
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .eBayGoodStanding
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .EIASToken
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .FeedbackPrivate
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .FeedbackRatingStar
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .FeedbackScore
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .IDVerified
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .NewUser
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .RegistrationDate
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder.Site-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .Status
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .UserAnonymized
-Y-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .UserID
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .UserIDChanged
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .UserIDLastChanged
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.HighBidder
  .VATStatus
-(Y)-
ItemArray.Item.Variations.Variation.SellingStatus.QuantitySold-(Y)-
Seller-Y-
Seller.AboutMePage-Y-
Seller.eBayGoodStanding-Y-
Seller.FeedbackPrivate-Y-
Seller.FeedbackRatingStar-Y-
Seller.FeedbackScore-Y-
Seller.IDVerified-Y-
Seller.MotorsDealer-(Y)-
Seller.NewUser-Y-
Seller.RegistrationDate-Y-
Seller.SellerInfoYYY
Seller.SellerInfo.AllowPaymentEdit-Y-
Seller.SellerInfo.CheckoutEnabled-Y-
Seller.SellerInfo.CIPBankAccountStored-Y-
Seller.SellerInfo.GoodStanding-Y-
Seller.SellerInfo.MerchandizingPref-Y-
Seller.SellerInfo.QualifiesForB2BVAT-Y-
Seller.SellerInfo.SafePaymentExempt-Y-
Seller.SellerInfo.SellereBayPaymentProcessConsent(Y)(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent.PayoutMethod(Y)(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent.PayoutMethodSet(Y)(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo
(Y)(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.AcceptedTime
(Y)(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.SellereBayPaymentProcessEnableTime
(Y)(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.SellereBayPaymentProcessStatus
(Y)(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.Site
(Y)(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.UserAgreementURL
(Y)(Y)(Y)
Seller.SellerInfo.SellereBayPaymentProcessStatus(Y)(Y)(Y)
Seller.SellerInfo.SellerLevel-Y-
Seller.SellerInfo.StoreOwner-(Y)-
Seller.SellerInfo.StoreURL-(Y)-
Seller.SellerInfo.TopRatedSeller-(Y)-
Seller.Site-Y-
Seller.Status-Y-
Seller.UserAnonymized-Y-
Seller.UserID-Y-
Seller.UserIDChanged-Y-
Seller.UserIDLastChanged-Y-
Seller.VATStatus-Y-



Back to top

GetSellerList Samples

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

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

Sample: Basic Call

Returns a list of all items that a seller is currently selling on eBay

Description

Magical Bookseller wants a list of all items that she listed on eBay during a particular two week period.

Input

Since the call does not specify a UserID, GetSellerList lists the items for the user making the call. Use StartTimeFrom and StartTimeTo to define the two week period.

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

<?xml version="1.0" encoding="utf-8"?>
<GetSellerListRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
  <GranularityLevel>Coarse</GranularityLevel> 
  <StartTimeFrom>2010-02-12T21:59:59.005Z</StartTimeFrom> 
  <StartTimeTo>2010-02-26T21:59:59.005Z</StartTimeTo> 
  <IncludeWatchCount>true</IncludeWatchCount> 
  <Pagination> 
    <EntriesPerPage>2</EntriesPerPage> 
  </Pagination> 
</GetSellerListRequest>

Output

XML format.
<GetSellerListResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-02-26T22:02:38.968Z</Timestamp>
  <Ack>Success</Ack>
  <Version>657</Version>
  <Build>E657_CORE_BUNDLED_10708779_R1</Build>
  <PaginationResult>
    <TotalNumberOfPages>14</TotalNumberOfPages>
    <TotalNumberOfEntries>27</TotalNumberOfEntries>
  </PaginationResult>
  <HasMoreItems>true</HasMoreItems>
  <ItemArray>
    <Item>
      <AutoPay>false</AutoPay>
      <BuyerProtection>ItemIneligible</BuyerProtection>
      <Country>US</Country>
      <Currency>USD</Currency>
      <GiftIcon>0</GiftIcon>
      <HitCounter>NoHitCounter</HitCounter>
      <ItemID>110043597553</ItemID>
      <ListingDetails>
        <StartTime>2010-02-12T23:35:27.000Z</StartTime>
        <EndTime>2010-02-19T23:35:27.000Z</EndTime>
        <ViewItemURL>http://cgi.sandbox.ebay.com/ws/eBayISAPI.dll?ViewItem&
           item=110043597553&category=41393</ViewItemURL>
        <HasUnansweredQuestions>false</HasUnansweredQuestions>
        <HasPublicMessages>false</HasPublicMessages>
        <BuyItNowAvailable>true</BuyItNowAvailable>
        <ExpressListing>false</ExpressListing>
      </ListingDetails>
      <ListingDuration>Days_7</ListingDuration>
      <Location>Santa Cruz, California</Location>
      <PrimaryCategory>
        <CategoryID>41393</CategoryID>
        <CategoryName>Collectibles:Decorative Collectibles:Other</CategoryName>
      </PrimaryCategory>
      <Quantity>1</Quantity>
      <ReviseStatus>
        <ItemRevised>false</ItemRevised>
      </ReviseStatus>
      <SecondaryCategory>
        <CategoryID>95116</CategoryID>
        <CategoryName>Collectibles:Disneyana:Contemporary (1968-Now):Bobblehead Figures</CategoryName>
      </SecondaryCategory>
      <SellingStatus>
        <BidCount>0</BidCount>
        <BidIncrement currencyID="USD">0.5</BidIncrement>
        <ConvertedCurrentPrice currencyID="USD">11.49</ConvertedCurrentPrice>
        <CurrentPrice currencyID="USD">11.49</CurrentPrice>
        <MinimumToBid currencyID="USD">11.49</MinimumToBid>
        <QuantitySold>0</QuantitySold>
        <SecondChanceEligible>false</SecondChanceEligible>
        <ListingStatus>Completed</ListingStatus>
      </SellingStatus>
      <ShippingDetails>
        <TaxTable/>
      </ShippingDetails>
      <ShipToLocations>US</ShipToLocations>
      <Site>US</Site>
      <Storefront>
        <StoreCategoryID>1</StoreCategoryID>
        <StoreCategory2ID>0</StoreCategory2ID>
        <StoreURL>http://www.stores.sandbox.ebay.com/id=132854966</StoreURL>
      </Storefront>
      <SubTitle>Micky, with the ears!</SubTitle>
      <TimeLeft>PT0S</TimeLeft>
      <Title>Kelly's Kitsch</Title>
      <WatchCount>0</WatchCount>
      <LocationDefaulted>true</LocationDefaulted>
      <PostalCode>95062</PostalCode>
      <PictureDetails>
        <GalleryURL>http://thumbs.ebaystatic.com/pict/41007087008080_0.jpg</GalleryURL>
        <PhotoDisplay>None</PhotoDisplay>
        <PictureURL>http://thumbs.ebaystatic.com/pict/41007087008080_0.jpg</PictureURL>
      </PictureDetails>
      <ProxyItem>false</ProxyItem>
      <BuyerGuaranteePrice currencyID="USD">20000.0</BuyerGuaranteePrice>
      <ReturnPolicy>
        <RefundOption>MoneyBack</RefundOption>
        <Refund>Money Back</Refund>
        <ReturnsWithinOption>Days_30</ReturnsWithinOption>
        <ReturnsWithin>30 Days</ReturnsWithin>
        <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
        <ReturnsAccepted>Returns Accepted</ReturnsAccepted>
        <Description>Returns accepted only if item is not as described.</Description>
        <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
        <ShippingCostPaidBy>Buyer</ShippingCostPaidBy>
      </ReturnPolicy>
      <PaymentAllowedSite>US</PaymentAllowedSite>
    </Item>
    <Item>
      <AutoPay>false</AutoPay>
      <BuyerProtection>NoCoverage</BuyerProtection>
      <Country>US</Country>
      <Currency>USD</Currency>
      <GiftIcon>0</GiftIcon>
      <HitCounter>BasicStyle</HitCounter>
      <ItemID>110043598136</ItemID>
      <ListingDetails>
        <StartTime>2010-02-12T23:45:03.000Z</StartTime>
        <EndTime>2010-02-19T23:45:03.000Z</EndTime>
        <ViewItemURL>http://cgi.sandbox.ebay.com/ws/eBayISAPI.dll?ViewItem&
            item=110043598136&category=5332</ViewItemURL>
        <HasUnansweredQuestions>false</HasUnansweredQuestions>
        <HasPublicMessages>false</HasPublicMessages>
        <LocalListingDistance>100</LocalListingDistance>
        <ExpressListing>false</ExpressListing>
      </ListingDetails>
      <ListingDuration>Days_7</ListingDuration>
      <Location>San Jose, California</Location>
      <PrimaryCategory>
        <CategoryID>5332</CategoryID>
        <CategoryName>eBay Motors:Cars & Trucks:Acura:CL</CategoryName>
      </PrimaryCategory>
      <Quantity>1</Quantity>
      <ReviseStatus>
        <ItemRevised>false</ItemRevised>
      </ReviseStatus>
      <SellingStatus>
        <BidCount>0</BidCount>
        <BidIncrement currencyID="USD">0.0</BidIncrement>
        <ConvertedCurrentPrice currencyID="USD">60.0</ConvertedCurrentPrice>
        <CurrentPrice currencyID="USD">60.0</CurrentPrice>
        <MinimumToBid currencyID="USD">60.0</MinimumToBid>
        <QuantitySold>0</QuantitySold>
        <SecondChanceEligible>false</SecondChanceEligible>
        <ListingStatus>Completed</ListingStatus>
      </SellingStatus>
      <ShippingDetails>
        <TaxTable/>
      </ShippingDetails>
      <ShipToLocations>None</ShipToLocations>
      <Site>eBayMotors</Site>
      <Storefront>
        <StoreCategoryID>1</StoreCategoryID>
        <StoreCategory2ID>0</StoreCategory2ID>
        <StoreURL>http://www.stores.sandbox.ebay.com/id=132854966</StoreURL>
      </Storefront>
      <TimeLeft>PT0S</TimeLeft>
      <Title>Acura : CL</Title>
      <WatchCount>0</WatchCount>
      <LocationDefaulted>true</LocationDefaulted>
      <BuyerResponsibleForShipping>true</BuyerResponsibleForShipping>
      <PostalCode>95125</PostalCode>
      <PictureDetails>
        <GalleryURL>http://i.ebayimg.com/04/!BPoEM4!BWk~$(KGrHgoH-CgEjlLl1-OzBJ0kciTH9Q~~_1.JPG</GalleryURL>
        <PhotoDisplay>None</PhotoDisplay>
        <PictureURL>http://i.ebayimg.com/04/!BPoEM4!BWk~$(KGrHgoH-CgEjlLl1-OzBJ0kciTH9Q~~_1.JPG</PictureURL>
      </PictureDetails>
      <LocalListing>true</LocalListing>
      <ProxyItem>false</ProxyItem>
      <ListingSubtype2>ClassifiedAd</ListingSubtype2>
      <BuyerGuaranteePrice currencyID="USD">0.0</BuyerGuaranteePrice>
      <PaymentAllowedSite>eBayMotors</PaymentAllowedSite>
      <PaymentAllowedSite>US</PaymentAllowedSite>
    </Item>
  </ItemArray>
  <ItemsPerPage>2</ItemsPerPage>
  <PageNumber>1</PageNumber>
  <ReturnedItemCountActual>2</ReturnedItemCountActual>
</GetSellerListResponse>



Back to top

GetSellerList Change History

Version Description
879
2014-06-17
  • PickupInStoreDetails.EligibleForPickupDropOff (added): This boolean field is returned as 'true' if the listing is enabled for the "Click and Collect" feature.
861
2014-02-11
  • StorefrontType.StoreCategoryName (added): This field is used by eBay Stores sellers to list an item under one of their custom categories using the category name.
  • StorefrontType.StoreCategory2Name (added): This field is used by eBay Stores sellers to list an item under a second category using one of their custom categories names.
859
2014-01-28
  • Item.OutOfStockControl (modified): OutOfStockControl can now be used with BestOffer.
851
2013-11-19
  • Item.ConditionDescription (modified): ConditionDescription is now supported on the following eBay sites: US and US Motors (0, 100), CA (2), CAFR (210), UK (3), AU (15), AT (16), BEFR (23), BENL (123) FR (71), DE (77), IT (101), NL (146), ES (186), CH (193), IE (205), PL (212).
849
2013-11-05
  • Item.ConditionDescription (modified): In addition to the eBay US and US eBay Motors (0), UK (3), CA (2), CAFR (210) and AU (15) sites, ConditionDescription is now supported on the AT (16), FR (71), IT (101) and ES (186) sites.
  • Item.PaymentMethods (modified): 'CreditCard' and 'DirectDebit' added as acceptable buyer payment methods. These two values will only be returned for eBay Now-enabled listings.
  • ShippingServiceOptions.ShippingService (modified): 'eBayNowImmediateDelivery' added as an acceptable value in the ShippingService field. This value will only be returned for eBay Now-enabled listings.
841
2013-09-19
  • Item.ShippingServiceCostOverrideList (added): This container is returned for a listing that is using shipping costs overrides to override the flat shipping costs for all domestic and/or all international shipping services defined in the Business Policies shipping profile referenced by the listing.
  • Item.eBayNowEligible (added): This boolean field indicates if the listing is enabled for eBay Now delivery. A seller must be eligible for the eBay Now delivery feature to list an item that is eligible for eBay Now delivery.
831
2013-07-03
  • Item.PickupInStoreDetails (added): A new container that is used to enable a multi-quantity, fixed-price listing with the In-Store Pickup option. If an eligible seller/merchant enables the In-Store Pickup option, the buyer of the item will have the option of picking up that item at one of the merchant's retail locations at no charge. Besides including and setting the EligibleForPickupInStore flag to 'true', there are additional requirements that the seller must follow when listing an In-Store Pickup item. These requirements are discussed in the description of the EligibleForPickupInStore field.
829
2013-06-19
  • ReturnPolicy.RefundOption (modified): A new 'MoneyBackOrReplacement' value is now supported. This value should be used by a seller opted in to eBay-managed returns who wants to give buyers the choice of receiving a refund for a returned item, or receiving a replacement item.
825
2013-05-22
  • ReturnPolicy.ReturnsWithinOption (modified): A new 'Months_1' value is now supported. This value indicates a one-month return policy.
823
2013-05-08
  • Item.OutOfStockControl (added): Flag that when set to 'true' hides a listing when the quantity of the item goes to 0 (zero) but keeps the listing alive. While the "quantity available" value is 0, the listing would be hidden from eBay search, and if that item was specifically searched for with GetItem (or related call), the 'OutOfStock' Enum would be returned. This is useful for a seller who is waiting for additional stock of an item. Instead of ending the listing and then recreating it when the inventory arrives, they can use this flag to hide the listing. Then when they have the item available they can update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields in an AddFixedPriceItem call) and the listing would appear again.
799
2012-11-07
  • ShippingDetailsType.InternationalShippingServiceOption (doc change): The description clarifies that 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).
793
2012-09-26
  • ShippingDetails.GlobalShipping (added): If the value of GlobalShipping is true, the Global Shipping Program is the default international shipping option for the listing, and eBay designates an appropriate international shipping service. If the value of GlobalShipping is false, the seller is responsible for specifying an international shipping service for the listing if desired.
  • BuyerInfo.ShippingAddress (modified): For a Global Shipping Program order, the Country field and the PostalCode field now return the country code and postal code, respectively, of the buyer, not those of the international shipping provider.
791
2012-09-12
  • InternationalShippingServiceOption.ShippingService (modified): New International shipping services added for UK and DE sites as part of the EU delivery estimate project. For UK, these new enumeration values are UK_ParcelForceIntlExpress, UK_ParcelForceIntlValue, and UK_ParcelForceIntlEconomy. For DE, these new enumeration values are DE_DeutschePostBriefIntlEcon and DE_DeutschePostBriefIntlPriority.
789
2012-08-29
  • Item.ConditionDescription (added): This string field is used by the seller to more clearly describe the condition of items that are not brand new.
  • Item.ListingSubtype2 (doc change): A note was added to clarify that this value indicates a classified ad (or digital download) listing on ebay.com websites, not on ebayclassifieds.com. The ebayclassifieds.com site is not supported by the Trading API.
787
2012-08-15
  • Item.ShippingDetails.RateTableDetails (doc change): Documentation for this container and its fields has been revised to be more accurate and easier to understand.
  • Item.ShippingDetails.RateTableDetails.InternationalRateTable (added): This field specifies which international shipping rate table to apply to a listing. International rate tables can be used only for items listed on the DE or UK site, and the seller must have previously configured a table in My eBay site preferences. Shipping rate tables enable sellers to tailor the flat shipping rates offered for an item to fit the shipping destination. They can specify a base rate for a large region, then define alternative rates or surcharges for shipping to individual countries within the region.
783
2012-07-18
  • ReturnPolicy.RestockingFeeValueOption (added): This enumeration value indicates the restocking fee charged by the seller for returned items. In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy.
  • ReturnPolicy.RestockingFeeValue (added): This value is directly related to the RestockingFeeValueOption value, with the difference being that applications can use RestockingFeeValue to present the RestockingFeeValueOption value in a more user-friendly format.
781
2012-07-04
  • ShippingServiceCodeType (modified): AU_StandardDeliveryFromOutsideAU added as a shipping service option. This option can be specified by sellers on the AU site if the item is being shipped from a location outside of Australia using standard delivery.
765
2012-03-14
  • Seller.SellerInfo.SellereBayPaymentProcessConsent (added): This response container is returned to DE/AT sellers ramped up in the new eBay payment process. This container consists of information related to the seller's signing of the supplemental user agreement and payout preferences.
  • Seller.SellerInfo.SellereBayPaymentProcessStatus (added): This response field contains an enumeration value that indicates the current status of a DE or AT seller's account related to the new eBay payment process.
763
2012-02-29
  • Item.SellerProfiles.SellerPaymentProfile (added): This container is returned if a Business Policies payment profile was applied to the listing. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
  • Item.SellerProfiles.SellerReturnProfile (added): This container is returned if a Business Policies return policy profile was applied to the listing. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
  • Item.SellerProfiles.SellerShippingProfile (added): This container is returned if a Business Policies shipping profile was applied to the listing. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
  • Item.ShippingPackageDetails (added): If the seller is using calculated shipping, this container is used to specify the weight and dimensions of an item's shipping package. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
735
2011-08-17
  • Item.ItemSpecifics (modified): Ticket listings return custom item specifics instead of ID-based attributes.
  • Item.ReturnPolicy.RefundOption (modified): MoneyBackOrExchange value is now supported.
719
2011-04-27
  • ShippingServiceCodeType (modified): 15 new shipping services added for the Australia and Canada sites. The nine new Australia carrier-specific shipping services include AU_AusPostRegisteredPostInternationalPaddedBag1kg, AU_AusPostRegisteredPostInternationalPaddedBag500g, AU_AusPostRegisteredPostInternationalParcel, AU_AustralianAirExpressFlatRate1kg, AU_AustralianAirExpressFlatRate3kg, AU_AustralianAirExpressFlatRate5kg, AU_AustralianAirExpressMetro15kg, AU_eBayAusPost3kgFlatRateSatchel, and AU_eBayAusPost500gFlatRateSatchel. The nine new Australia generic service level shipping services include AU_EconomyDeliveryFromOutsideAU, AU_ExpeditedDeliveryFromOutsideAU, AU_ExpressDelivery, AU_Freight, and AU_StandardDelivery. The new Canada shipping service is CA_Freight.
  • Item.ShippingDetails.ShippingServiceOptions (modified): '4' has been added as a valid integer value to account for the additional international shipping service that may be specified by the seller.
  • Item.ShippingDetails.InternationalShippingServiceOption (modified): '4' and '5' have been added as valid integer values to account for the additional international shipping services that may be specified by the seller.
689
2010-09-20
  • ShippingType.ApplyShippingDiscount (deprecated): As of version 689, ApplyShippingDiscount is deprecated and removed from the schema.
679
2010-07-21
  • ItemType.QuantityThreshold, Itemtype.QuantityAvailableHint (added): Set a quantity threshold for the number of items available. As long as the number of items remains above the threshold, GetSellerList will return a quantity in the form, "More than n available," where n is the quantity threshold.
663
2010-03-31
  • ShippingType.ApplyShippingDiscount (deprecated): This tag is no longer being used. It will be officially deprecated later in 2010.
635
2009-09-16
  • ExcludeShipToLocation, SellerExcludeShipToLocationsPreference (added): Sellers can now exclude specific regions and countries from where they will ship items.
  • InsuranceDetails, InsuranceFee, InsuranceOption, InternationalInsuranceDetails, InsuranceWanted, ShippingInsuranceCost (modified): Sellers can no longer give buyers the option to purchase shipping insurance for either domestic or international items. The buyer-paid shipping insurance option has been removed from the following sites:
    BEFR, BENL, CA, CAFR, HK, IE, IN, MY, Motors, NL, PH, PL, SG, UK, US
    Insurance tags are returned only when the associated item has buyer-paid shipping insurance values.
629
2009-08-05
  • TopRatedSeller (added): Returned when seller is a Top-Rated Seller.
619
2009-05-27
  • IncludeVariations, Variations (added): Use IncludeVariations to retrieve details about multi-variation listings.
605
2009-02-18
  • NowAndNew (deprecated): Now & New (Sofort & Neu) has been retired as of this release.
603
2009-02-04
  • Item.IntegratedMerchantCreditCardEnabled (added): Indicates that the IntegratedMerchantCreditCard payment method applies to the item.
599
2009-1-07
  • NowAndNew (doc change): eBay will retire Now & New (Sofort & Neu) by March 2009.
581
2008-09-03
  • ItemArray.Item.ReturnPolicy (added): Specifies the seller's return policy.
573
2008-07-09
  • ItemArray.Item.DigitalDeliveryDetails (deprecated): The digital delivery feature is disabled as of March 28, 2008. GetSellerList no longer returns digital delivery details for digital download items.
567
2008-05-28
  • CategoryID (added): You can specify a category ID for the items retrieved.
  • EndTimeFrom, EndTimeTo, StartTimeFrom, StartTimeTo (modified): The maximum time range allowed in a request is 120 days.
563
2008-04-30
  • Item.BuyerGuaranteePrice (added): On the Australia site, by early June 2008, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.
  • BuyerProtection.NoCoverage (added): On the Australia site, by early June 2008, indicates that there is no PayPal Buyer Protection coverage.
561
2008-04-16
  • Item.ListingType.Express (deprecated): Due to the shutdown of UK and Germany eBay Express sites Item.ListingType.Express has been deprecated.
559
2008-04-02
  • Item.CrossBorderTrade (added): For a fee, enables a listing to be displayed in the default search results of another eBay site. Applicable beginning in early May 2008.
557
2008-03-19
  • Item.SellingStatus.AdminEnded (added): If included in the response as true, indicates that the listing was canceled due to a violation of eBay's listing policies and that the item can be relisted using RelistItem.
  • Item.ItemPolicyViolation.PolicyID (added): If a violation of an eBay listing policy has occurred, indicates the integer ID of the violated policy in the response. Applies to all eBay sites, including eBay Motors and Express (does not include Half.com).
  • Item.ItemPolicyViolation.PolicyText (added): If a violation of an eBay listing policy has occurred, provides a textual description of the violated policy in the response. Applies to all eBay sites, including eBay Motors and Express (does not include Half.com).
  • AdminEndedItemsOnly (added): If included in the request as true, the response will return only administratively ended items for any policy violation.
555
2008-03-05
  • GetSellerListRequestType.UserIDType (modified): Note that since user information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers looking for information about their own listings and bidders who know the user IDs of their sellers will be able to make this API call successfully.
553
2008-02-20
  • ProductListingDetails.StockPhotoURL (doc change): The documentation has been corrected to remove this container and element.
551
2008-02-06
  • HitCount (added): The number of hits on an item.
537
2007-10-31
  • Item.PaymentMethods.PaisaPayEscrow, Item.PaymentMethods.PaisaPayEscrowEMI (added): These enum will be returned for items offering PaisaPayEscrow and PaisaPayEscrowEMI payment methods.
  • BestOfferAutoAcceptPrice (added): The price at which best offers are automatically accepted.
507
2007-04-04
  • PayPerLeadEnabled (added): Added for the pay-per-lead feature, applicable beginning in upcoming months on the US site.
503
2007-03-07
  • SellerType.SafePaymentExcempt (added): This field indicates whether a seller is exempt from providing a safe payment method. If a seller is exempt, any safe payment restrictions for a site or a category do not apply.
499
2007-02-07
  • AnythingPoints, ProximitySearchDetails.PostalCode, SellerKey, ShippingDetails.AllowPaymentEdit, ShippingDetails.SellerPostalCode, SiteHostedPicture, SkypeOption, VendorHostedPicture (modified): Deleted previously deprecated objects from the latest schema. Some of these objects are still supported with lower request versions. See Deprecated Objects.
  • ItemArray.Item.Storefront.StoreCategoryID, ItemArray.Item.Storefront.StoreCategory2ID (modified): The data types for IDs used for eBay Stores have changed from xs:int to xs:long to prepare for future increases in ID values.
  • ExtendedSellerContactDetails (added): Returns seller contact details.
497
2007-01-24
  • ItemArray.Item.SellingStatus.PromotionalSaleDetails (added): 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.
491
2006-12-13
  • Item.ListingCheckoutRedirectPreference.ProStoresStoreName (doc change): Added this existing field to the GetSellerList documentation.
  • Item.SellingStatus.HighBidder.MotorsDealer (doc change): Not returned. Removed from output topic.
  • Item.ShippingDetails (doc change): InternationalShippingServiceOption.ShippingInsuranceCost and ShippingServiceOptions.ShippingInsuranceCost are not returned. Removed from output topic.
  • Item.ListingDetails.ViewItemURLForNaturalSearch (added): A variation of ViewItemURL optimized for popular search engines.
  • UserType (modified): Starting Jan 2007, selected tags in the User container will be made anonymous for listings that have a current price of $200.00 USD or higher. See Working with Anonymous User Information for a list of effected fields.
489
2006-11-29
  • ItemArray.Item.WatchCount (doc change): ItemArray.Item.WatchCount added to GetSellerList output fields.
483
2006-10-18
  • Item.AnythingPoints (deprecated): No longer returned as of request version 483.
  • Item.ProximitySearchDetails (deprecated): No longer returned as of request version 483. Use Item.PostalCode instead.
  • Item.ShippingDetails.SellerPostalCode (deprecated): No longer returned as of request version 483. Use Item.PostalCode instead.
477
2006-09-06
  • ListingType (modified): Chinese auction listings with Buy It Now are eligible for Express US.
  • ShippingTypes: CalculatedDomesticFlatInternational, FlatDomesticCalculatedInternational (added): Two more shipping types were introduced to enable a seller to use flat rate shipping for the domestic services and calculated shipping for the international shipping services, or vice versa. See the Managing Shipping documentation for details.
  • ShippingServiceOptions.ShippingSurcharge (added): A cost that the seller can add for flat rate shipping for eBay US and Motors Parts and Accessories. See the Managing Shipping documentation for details.
  • ShippingDetails.InternationalPackagingHandlingCosts (added): A means of distinguishing international packaging/handling costs from domestic costs. See the Managing Shipping documentation for details.
  • ShippingDetails.InsuranceDetails (added): A container of details about insurance for the domestic shipping services. See the Managing Shipping documentation for details.
  • ShippingDetails.InternationalInsuranceDetails (added): A container of details about insurance for the international shipping services.
471
2006-7-26
  • DetailLevel (doc change): Clarified best practices. Please avoid using ReturnAll when possible. Use a GranularityLevel or use GetSellerEvents instead. If you use ReturnAll, use a small EntriesPerPage value and short end time range for better performance.
469
2006-7-12
  • Seller.SellerInfo.ExpressWallet (added): Indicates whether the seller has an Express wallet.
  • ItemArray.Item.SellingStatus.HighBidder.MotorsDealer (added): Indicates if an item is listed for sale by owner (FSBO) or listed by a dealer. Applies to eBay Motors Pro applications only.
  • ItemArray.Item.ProxyItem (added): Affiliate-related field.
  • MotorsDealerUsers (added): Specifies the list of Motors Dealer sellers for which a special set of metrics can be requested.
  • ItemArray.Item.TotalQuestionCount (added): The number of questions asked about the item.
465
2006-06-14
  • ItemArray.Item.ListingCheckoutRedirectPreference (added): ProStores listing level preferences regarding the store to which checkout should be redirected for the listing if ThirdPartyCheckout is true.
  • ItemArray.Item.SkypeContactOption (added): Specifies the Skype contact options supported.
463
2006-5-31
  • Sample (doc change): A DetailLevel of ReturnAll should NOT be used with this call.
459
2006-05-03
  • Seller.SellerInfo.ExpressEligible (added): Indicates whether the seller is eligible to list on Express.
  • ItemArray.Item.ListingDetails.ExpressListing (added): Indicates whether the listing is included on Express.
  • ItemArray.Item.ListingType [Express] (added): Added a new Express-only format for Express Germany users.
455
2006-5-5
  • Item.ThirdPartyCheckoutIntegration (added): Used by third party checkout providers to opt an item into eBay Express (and thus approve handling of checkout by eBay Express).
453
2006-3-22
  • Item.BuyerRequirements and Item.DisableBuyerRequirements (added): Buyer requirements can now be specified per listing (and not just via My eBay). Buyer requirements can also be updated on active listings, applying only to subsequent bids.
439
2005-12-14
  • Item.PictureDetails (added): SiteHostedPicture and VendorHostedPicture contain data for pictures associated with an item. With compatibility level 439 and higher, that data will be returned in PictureDetails instead, regardless of the input.
427
2005-09-21
  • Item.SellingStatus.ListingStatus (added): Specifies an active or ended listing's status in eBay's processing workflow. For items that have sold, this to determine whether eBay has finished processing total price, winning bidder/buyer, and Final Value Fee details.
425
2005-9-7
  • IncludeWatchCount (added): Input argument that returns the WatchList element in Item objects.
419
2005-7-27
  • GranularityLevel (added): Filter to control the amount of data returned per record (similar to DetailLevel).
415
2005-5-29
  • Item.GetItFast (added): This field supports the new Get It Fast feature.
411
2005-6-1
  • BuyerResponsibleForShipping (added): For eBay Motors vehicle listings, flag that indicates shipping arrangements.
  • InsuranceOption (modified): New NotOfferedOnSite value added to ShippingDetails.InsuranceOption.
  • ShippingPackage (modified): A new value, ExtraLargePack, has been added.
  • LimitedWarrantyEligible (added): For eBay Motors vehicle listings, flag that indicates that the vehicle has not been modified or is not a special type.



Back to top

User-Contributed Notes

 

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