eBay Trading APIVersion 1379
 

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.

Short-duration call rate limit: To protect eBay's infrastructure and servers from being overloaded and/or destabilized, the GetSellerList call has a short-duration call rate limit to restrict bursts of very high traffic.

Per (seller) user ID, no more than 300 GetSellerList calls can be executed within any 15-second interval. If this call rate limit is exceeded at any time, the application making the called is blocked. Each time an application is blocked, the user/application must wait until the block is reset after 15 seconds. This short-duration call rate limit applies to all seller accounts, and sellers/developers cannot appeal or request for a higher limit.

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 Browse a seller's items.

See also the reference documentation for this call:



Input

See also Samples.

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

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

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

<?xml version="1.0" encoding="utf-8"?>
<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>
  <!-- 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 This boolean field can be included and set to true if the seller would like to retrieve any listings that were administratively ended by eBay due to a listing policy violation.
Default: false.
CategoryID int Optional If you specify a CategoryID value, the response will only contain listings 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 This field allows the user to control the amount of data that is returned in the response. See the Granularity Level table on this page for a list of the fields that are returned for each granularity level. Either GranularityLevel or DetailLevel can be used in a GetSellerList call, but not both. If both are specified, DetailLevel is ignored. If neither are used, the response fields will be the ones shown for 'Coarse' granularity.
Default: Coarse.

Applicable values:

Coarse
(in) For each record in the response, retrieves less data than Medium. See the Standard input data section of the Making a Trading API call 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 Standard input data section of the Making a Trading API call 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 Standard input data section of the Making a Trading API call guide for a list of the output fields that are returned when this level is specified.
IncludeVariations boolean Optional If this field is included and set to true, the Variations node is returned for all multi-variation listings in the response.

Note: If the seller has many multiple-variation listings, that seller may not want to include variations in the GetSellerList response. Or, a seller can include variations data, but possibly limit the response by specifying shorter date ranges with the date range filters, or by reducing the number of listings returned per results (decreasing the Pagination.EntriesPerPage value).
IncludeWatchCount boolean Optional This field may be included and set to true if the seller wishes to see the number of eBay users that are watching each listing.
Default: false.
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 This container controls the maximum number of listings that can appear on one page of the result set, as well as the page number of the result to return.

The GetSellerList call requires that the EntriesPerPage value be set. The PageNumber field is not required but will default to 1 if not included.
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.

The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.
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 the individual calls to determine the correct default value.
SKUArray SKUArrayType Optional This container can be used to specify one or multiple SKUs, and only listings associated with these SKUs are retrieved. Note that all other request criteria are also considered when one or more SKU values are specified.

Note: Listings with matching SKUs are returned regardless of their Item.InventoryTrackingMethod setting.
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.
Max length: 50.
Sort int Optional This field can be used to control the order in which returned listings are sorted (based on the listings' actual/scheduled end dates). Valid values are as follows:
  • 1 (descending order)
  • 2 (ascending order)

Default: 2 (Ascending).
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.
Standard Input Fields  
DetailLevel DetailLevelCodeType Optional,
repeatable: [0..*]
Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data.

Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request.

The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it and processes the request without it.

For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level.

Note that DetailLevel is required input for GetMyMessages.

With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use GranularityLevel instead, or use GetSellerEvents. If you do use 'ReturnAll' with GetSellerList, use a small Pagination.EntriesPerPage value and a narrow EndTimeFrom/EndTimeTo date range for better performance.

Applicable values:

ItemReturnDescription
(in) Returns the 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. Below are some examples from different countries.

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
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 field(s) you specified in the request, as well as all of its child fields (if a field is a container) and its parent fields (if any). Note that it is possible that a field included through an OutputSelector field may still not be returned if it is not applicable, or if it is not found based on other criteria set up in the request payload.

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:

 If the following output selectors are used: 

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

...

...the response might look like the following

<Item>
<BuyItNowPrice currencyID="USD">0.0</BuyItNowPrice>
<ListingDetails>
<ViewItemURL>http://www.ebay.com/itm/Tag-Heuer-Mens-Watch/182879833261</ViewItemURL>
</ListingDetails>
</Item>

See OutputSelector.

Version string Conditional The version number of the API code that you are programming against (e.g., 1149). 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:
    HTTP headers
    eBay Schema Versioning Strategy
    Lowest Supported Version

WarningLevel WarningLevelCodeType Optional Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment.

Applicable values:

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

See Warning Level.



Output

See also Samples.

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

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

<?xml version="1.0" encoding="utf-8"?>
<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>
      <BuyerRequirementDetails> BuyerRequirementDetailsType
        <MaximumItemRequirements> MaximumItemRequirementsType
          <MaximumItemCount> int </MaximumItemCount>
          <MinimumFeedbackScore> int </MinimumFeedbackScore>
        </MaximumItemRequirements>
        <MaximumUnpaidItemStrikesInfo> MaximumUnpaidItemStrikesInfoType
          <Count> int </Count>
          <Period> PeriodCodeType </Period>
        </MaximumUnpaidItemStrikesInfo>
        <ShipToRegistrationCountry> boolean </ShipToRegistrationCountry>
        <ZeroFeedbackScore> boolean </ZeroFeedbackScore>
      </BuyerRequirementDetails>
      <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
      <Charity> CharityType
        <CharityID> string </CharityID>
        <CharityListing> boolean </CharityListing>
        <CharityName> string </CharityName>
        <DonationPercent> float </DonationPercent>
        <LogoURL> string </LogoURL>
        <Mission> string </Mission>
        <Status> CharityStatusCodeType </Status>
      </Charity>
      <ConditionDescription> string </ConditionDescription>
      <Country> CountryCodeType </Country>
      <CrossBorderTrade> string </CrossBorderTrade>
      <!-- ... more CrossBorderTrade values allowed here ... -->
      <Currency> CurrencyCodeType </Currency>
      <Description> string </Description>
      <DisableBuyerRequirements> boolean </DisableBuyerRequirements>
      <DiscountPriceInfo> DiscountPriceInfoType
        <MadeForOutletComparisonPrice currencyID="CurrencyCodeType"> AmountType (double) </MadeForOutletComparisonPrice>
        <MinimumAdvertisedPrice currencyID="CurrencyCodeType"> AmountType (double) </MinimumAdvertisedPrice>
        <MinimumAdvertisedPriceExposure> MinimumAdvertisedPriceExposureCodeType </MinimumAdvertisedPriceExposure>
        <OriginalRetailPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalRetailPrice>
        <PricingTreatment> PricingTreatmentCodeType </PricingTreatment>
        <SoldOffeBay> boolean </SoldOffeBay>
        <SoldOneBay> boolean </SoldOneBay>
      </DiscountPriceInfo>
      <eBayPlus> boolean </eBayPlus>
      <eBayPlusEligible> boolean </eBayPlusEligible>
      <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>
      <HideFromSearch> boolean </HideFromSearch>
      <HitCount> long </HitCount>
      <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
      <InventoryTrackingMethod> InventoryTrackingMethodCodeType </InventoryTrackingMethod>
      <IsSecureDescription> boolean </IsSecureDescription>
      <ItemID> ItemIDType (string) </ItemID>
      <ItemPolicyViolation> ItemPolicyViolationType
        <PolicyID> long </PolicyID>
        <PolicyText> string </PolicyText>
      </ItemPolicyViolation>
      <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>
        <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>
      <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
      <!-- ... more PaymentMethods values allowed here ... -->
      <PickupInStoreDetails> PickupInStoreDetailsType
        <EligibleForPickupDropOff> boolean </EligibleForPickupDropOff>
        <EligibleForPickupInStore> boolean </EligibleForPickupInStore>
      </PickupInStoreDetails>
      <PictureDetails> PictureDetailsType
        <GalleryType> GalleryTypeCodeType </GalleryType>
      </PictureDetails>
      <PrimaryCategory> CategoryType
        <CategoryID> string </CategoryID>
        <CategoryName> string </CategoryName>
      </PrimaryCategory>
      <PrivateListing> boolean </PrivateListing>
      <ProxyItem> boolean </ProxyItem>
      <Quantity> int </Quantity>
      <QuantityAvailableHint> QuantityAvailableHintCodeType </QuantityAvailableHint>
      <QuantityThreshold> int </QuantityThreshold>
      <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch>
      <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
      <ReturnPolicy> ReturnPolicyType
        <Description> string </Description>
        <InternationalRefundOption> token </InternationalRefundOption>
        <InternationalReturnsAcceptedOption> token </InternationalReturnsAcceptedOption>
        <InternationalReturnsWithinOption> token </InternationalReturnsWithinOption>
        <InternationalShippingCostPaidByOption> token </InternationalShippingCostPaidByOption>
        <Refund> string </Refund>
        <RefundOption> token </RefundOption>
        <ReturnsAccepted> string </ReturnsAccepted>
        <ReturnsAcceptedOption> token </ReturnsAcceptedOption>
        <ReturnsWithin> string </ReturnsWithin>
        <ReturnsWithinOption> token </ReturnsWithinOption>
        <ShippingCostPaidBy> string </ShippingCostPaidBy>
        <ShippingCostPaidByOption> token </ShippingCostPaidByOption>
      </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
        <CalculatedShippingRate> CalculatedShippingRateType
          <InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts>
          <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
        </CalculatedShippingRate>
        <ExcludeShipToLocation> string </ExcludeShipToLocation>
        <!-- ... more ExcludeShipToLocation values allowed here ... -->
        <GlobalShipping> boolean </GlobalShipping>
        <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>
        <RateTableDetails> RateTableDetailsType
          <DomesticRateTable> string </DomesticRateTable>
          <DomesticRateTableId> string </DomesticRateTableId>
          <InternationalRateTable> string </InternationalRateTable>
          <InternationalRateTableId> string </InternationalRateTableId>
        </RateTableDetails>
        <SalesTax> SalesTaxType
          <SalesTaxPercent> float </SalesTaxPercent>
          <SalesTaxState> string </SalesTaxState>
          <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
        </SalesTax>
        <SellerExcludeShipToLocationsPreference> boolean </SellerExcludeShipToLocationsPreference>
        <ShippingServiceOptions> ShippingServiceOptionsType
          <ExpeditedService> boolean </ExpeditedService>
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <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>
        <ThirdPartyCheckout> boolean </ThirdPartyCheckout>
      </ShippingDetails>
      <ShippingServiceCostOverrideList> ShippingServiceCostOverrideListType
        <ShippingServiceCostOverride> ShippingServiceCostOverrideType
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShippingServiceType> ShippingServiceType </ShippingServiceType>
        </ShippingServiceCostOverride>
        <!-- ... more ShippingServiceCostOverride nodes allowed here ... -->
      </ShippingServiceCostOverrideList>
      <ShipToLocations> string </ShipToLocations>
      <!-- ... more ShipToLocations values allowed here ... -->
      <Site> SiteCodeType </Site>
      <SKU> SKUType (string) </SKU>
      <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>
          <VariationProductListingDetails> VariationProductListingDetailsType
            <EAN> string </EAN>
            <ISBN> string </ISBN>
            <UPC> string </UPC>
          </VariationProductListingDetails>
          <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>
    <NewUser> boolean </NewUser>
    <RegistrationDate> dateTime </RegistrationDate>
    <SellerInfo> SellerType
      <AllowPaymentEdit> boolean </AllowPaymentEdit>
      <CheckoutEnabled> boolean </CheckoutEnabled>
      <CIPBankAccountStored> boolean </CIPBankAccountStored>
      <GoodStanding> boolean </GoodStanding>
      <QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
      <SafePaymentExempt> boolean </SafePaymentExempt>
      <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 Always This field's value is returned as true if there are more pages in the current result set to view, or false if the current page being viewed is the last (or only) page of the result set.

If there are more listings to view in the result set, additional GetSellerList calls can be made but with changes to the Pagination values in the request. For example, if the Pagination.PageNumber value in the request for the last call was 1, you can make another GetSellerList call, keeping everything the same except changing the value of the Pagination.PageNumber field from 1 to 2.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray ItemArrayType Always This container is an array of one or more listings that match the input criteria. If none of the seller's listings match the input criteria, this container is returned as an empty tag.

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 the eBayAuthToken) has an order relationship with that buyer.

For calls that support detail levels, the set of fields returned is also controlled by the value of DetailLevel in the request. For some calls, other parameters in the request can also control the data returned for each item. For example, GranularityLevel controls the fields to return for each item in the GetSellerList response.
Note: When making a GetSellerList call, items that are on-hold due to an eBay policy violation will not be returned in the response.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ApplicationData string Conditionally Return 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.

Max length: 32.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.AutoPay boolean Conditionally This field is included and set to if true in an Add/Revise/Relist call if the seller wants to require immediate payment from the buyer. If this field is set to false or not included, the seller is not requesting immediate payment.

Note that this field may be set to true, but that does not necessarily mean that the buyer will be required to pay right away. For example, immediate payment is not currently applicable to auctions items won in a competitive bidding process or to items where the buyer and seller negotiated the price through the Best Offer feature. Immediate payment is also not applicable to listings where the payment happens offline between the buyer and seller.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item
  .BuyerGuaranteePrice
AmountType (double) Conditionally The eBay Best Price Guarantee price. The Best Price Guarantee program is only available on the eBay Australia marketplace.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item
  .BuyerGuaranteePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The eBay Best Price Guarantee price. The Best Price Guarantee program is only available on the eBay Australia marketplace.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.BuyerProtection BuyerProtectionCodeType Conditionally The enumeration value returned in this field indicates whether an item is eligible for the buyer protection.

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item
  .BuyerRequirementDetails
BuyerRequirementDetailsType Conditionally This container is returned if the seller has applied one or more buyer requirement criteria to the listing. Buyer requirement settings are managed in the Selling Preferences section of the seller's account in My eBay.
ItemArray.Item
  .BuyerRequirementDetails
  .MaximumItemRequirements
MaximumItemRequirementsType Conditionally This container is returned if the seller has set a maximum quantity threshold buyer requirement. With this buyer requirement, a buyer is limited in regards to the quantity of a line item that may be purchased.

This buyer requirement is only applicable to fixed-price listings where multiple quantity is available for purchase.

In addition to setting a maximum quantity threshold buyer requirement, the seller can also choose to apply this threshold to only those prospective buyers who don't meet or exceed the minimum Feedback score threshold.
ItemArray.Item
  .BuyerRequirementDetails
  .MaximumItemRequirements
  .MaximumItemCount
int Conditionally This field indicates the maximum quantity of a line item that one prospective buyer may purchase from the listing.

This buyer requirement is only applicable to fixed-price listings where multiple quantity is available for purchase.

If the MinimumFeedbackScore field is also set/returned, the maximum quantity threshold value will only apply to those prospective buyers who don't meet or exceed the minimum Feedback score threshold returned in that field. If the MinimumFeedbackScore field not set/returned, the maximum quantity threshold value will apply to all prospective buyers.

This field is always returned along with the MaximumItemRequirements container.
ItemArray.Item
  .BuyerRequirementDetails
  .MaximumItemRequirements
  .MinimumFeedbackScore
int Conditionally If this field is returned, it indicates that the seller has set a maximum quantity threshold value, but this maximum quantity threshold value (returned in MaximumItemCount will only apply to those prospective buyers who don't meet or exceed the minimum Feedback score threshold returned in this field. If this field is not returned, the maximum quantity threshold value will apply to all prospective buyers.
ItemArray.Item
  .BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
MaximumUnpaidItemStrikesInfoType Conditionally This container is returned if the seller has enabled a setting to block prospective buyers who have one or more unpaid items and/or buyer-initiated cancellations on their account during a specified time period.
ItemArray.Item
  .BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .Count
int Conditionally This integer value indicates the maximum number of unpaid items and/or buyer-initiated cancellations that a prospective buyer is allowed to have during a specified time period (MaximumUnpaidItemStrikesInfo.Period) before being blocked from buying or bidding on the item.
ItemArray.Item
  .BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .Period
PeriodCodeType Conditionally This enumerated value defines the length of time over which a prospective buyer's unpaid items and/or buyer-initiated cancellations will be counted. If the prospective buyer's number of unpaid items and/or buyer-initiated cancellations during this defined period exceeds the value set in the MaximumUnpaidItemStrikesInfo.Count field, that prospective buyer is blocked from buying/bidding on the item.

If the Count value is 2, and the specified Period is Days_30 (counting back 30 days from the present day), any prospective buyer that has had three or more unpaid items and/or buyer-initiated cancellations is blocked from buying/bidding on the item.

Applicable values:

CustomCode
(out) This value is reserved for future or internal use.
Days_180
(out) This value indicates that the evaluation period is set back 180 days (approximately 6 months) from the present date.
Days_30
(out) This value indicates that the evaluation period is set back 30 days from the present date.
Days_360
(out) This value indicates that the evaluation period is set back 360 days (approximately 12 months) from the present date.

Code so that your app gracefully handles any future changes to this list.
ItemArray.Item
  .BuyerRequirementDetails
  .ShipToRegistrationCountry
boolean Conditionally This field is returned as true if the seller has enabled the setting to block buyers/bidders who reside (according to their eBay primary shipping address) in countries that are on the seller's ship-to exclusion list.

Default: false.
ItemArray.Item
  .BuyerRequirementDetails
  .ZeroFeedbackScore
boolean Conditionally This field is returned as true if the seller has enabled the setting to block buyers/bidders with a feedback score of 0 from buying items.

Default: false.
ItemArray.Item.BuyItNowPrice AmountType (double) Conditionally This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

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

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

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

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine, Medium.
ItemArray.Item.BuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

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

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

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

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.Charity CharityType Conditionally This container identifies the nonprofit organization that will benefit with a percentage of the proceeds from each sale of an item through an auction or fixed-price listing. Charity names and IDs can be found by going to eBay for Charity page and doing a search. The donation percentage can be set in 5 percent increments from 10 percent to 100 percent.

When it comes to revising an auction or fixed-price listing, you can add a benefitting charity (as long as there is at least 12 hours left before end of listing/close of auction), but you cannot remove or change a nonprofit company once one is already established in the original listing.

For Revise calls: The non-profit organization and donation percentage can now be modified in a Revise call as long as there are no active bids on an auction listing, or no pending Best Offers/Counter Offers on a listing.

This container will only be returned in Get calls for charitable listings. Charitable listings are only supported in the US and UK marketplaces.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    Buying and selling on eBay to benefit nonprofit organizations
    Charitable listings

ItemArray.Item.Charity
  .CharityID
string Conditionally The unique identifier that eBay creates and assigns to each nonprofit organization.

The field is conditionally required in an Add/Revise/Relist call if the seller will be donating a percentage of the sale proceeds to this organization for each sale generated by the listing.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Charity
  .CharityListing
boolean Conditionally If this field is returned as true, a percentage of order line item's purchase price will be donated to a nonprofit organization.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Charity
  .CharityName
string Conditionally The full name of the nonprofit organization.


Max length: 150.

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 eBay for Charity listing. Possible values: 10.0 to 100.0. The DonationPercent field is required in an Add/Revise/Relist call if the seller will be donating a percentage of the sale proceeds for each sale generated by the listing.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Charity.LogoURL string Conditionally The full URL to the nonprofit organization's logo image file. This logo image file is the image that is displayed in all eBay listings that benefit that charity. This field is returned as long as it is defined for the nonprofit organization.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Charity.Mission string Conditionally The stated mission of the nonprofit charity organization. This mission statement is displayed in the eBay for Charity section of the View Item page.


Max length: 511.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Charity.Status CharityStatusCodeType Conditionally This enumeration value indicates whether or not the nonprofit organization is a valid eBay for Charity organization, and is able to receive proceeds from eBay sales.

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 PayPal Giving Fund.
Valid
(out) The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the PayPal Giving Fund.

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

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.

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.
Note: This field should not be included if ConditionDescriptors are being used. If it is used, a warning will be triggered and the field will be dropped from the listing.
Max length: 1000.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.Country CountryCodeType Conditionally This two-digit enumeration value indicates the country where the item is located. CountryCodeType defines the supported values. The GeteBayDetails call can also be used (include the DetailName field and set its value to CountryDetails) to see the full list of supported country codes.

In an Add/Revise/Relist/Verify call, this field is required.

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse.
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 Cross-border trading.

ItemArray.Item.Currency CurrencyCodeType Conditionally In an Add/Revise/Relist/Verify call, this required three-digit enumeration value defines the currency associated with the listing site. The item price and all costs passed in the call request will be using this currency. Similarly, the listing fees and other cost-related data will be using this currency. Since the Trading API can only be used for a select number of eBay sites, only a subset of values are supporting when adding/revising/relisting an item. These supported values are discussed in the top section of CurrencyCodeType.

In 'Get' calls, it is possible that any of the values in CurrencyCodeType may appear, as some cost-related fields will show the buyer's currency type.

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.Description string Conditionally The seller's 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. However, a seller can not use any active content in their listing description. Active content includes animation or video via JavaScript, Flash, plug-ins, or form actions. All active content will be blocked/removed from a listing. Removing/blocking active content will lead to faster load times of listings, make listings more mobile-friendly, improve SEO performance, and lead to a more secure eBay Marketplace.

Note: To ensure that a listing description is optimized to be viewed on a mobile devices, see Mobile device optimization in the Trading User Guide.

Note that the mobile-friendly description snippet feature described in this topic is currently only available in the following eBay marketplaces: US, UK, Australia, France, Germany, Italy, Spain, and eBay Motors.

In the listing description, sellers are only allowed to provide links to product videos, freight shipping services, or other legally required information, and when providing these links in the listing description, the secure 'https' protocol must be used instead of 'http'. In addition, any valid links to sites outside of eBay should use the target="_blank" attribute in the a href tag so a new browser window will be loaded when the link is clicked instead of buyers being redirected off of eBay. For more information on using links in the listing description, see eBay's Links policy. For more information about the stronger security standards that eBay is using, see the Use secure HTTPS for enhanced browser security topic in the 2018 Fall Seller Update. The getListingViolations method of the Compliance API can be used to see if any of the seller's active listings are not 'HTTPS' compliant.

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 the PictureURL field: https://pics.ebay.com/aw/pics/dot_clear.gif. See Add pictures in the Trading API User Guide.

This field is conditionally required for all listings. The exception is when the seller specifies a product identifier, such as a GTIN or ePID, through the ProductListingDetails container and a product match is found in the eBay product catalog. If a matching product is found in the eBay product catalog, the item description will be created automatically (as long as the ProductListingDetails.IncludeeBayProductDetails value is true).

Max length: 500000 (some sites may allow more, but the exact number may vary).

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .DisableBuyerRequirements
boolean Conditionally This field can be included and set to true in an Add or Revise call if the seller wishes to disable all buyer requirements (that are set in the seller's account) for the listing. (from Item.BuyerRequirementDetails or Buyer requirements preferences in My eBay) are ignored.

This field will only be returned in 'Get' calls if true.
Default: false.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .DiscountPriceInfo
DiscountPriceInfoType Conditionally This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price (MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings. STP is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, Spain, and Ireland sites, while MAP is available only on the US site.

Discount pricing is available to qualified sellers (and their associated developers) who participate in the Discount Pricing Program. Once qualified, sellers receive a 'special account flag' (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation items. STP is intended for eBay partners and their sellers only.

As a seller listing Discount Price items, you are required to maintain records of your discount pricing in the event you are called upon to substantiate your item pricing.

For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and VerifyAddFixedPriceItem: If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .DiscountPriceInfo
  .MadeForOutletComparisonPrice
AmountType (double) Conditionally Applicable only if the item was specifically made for sale through dedicated eBay outlet pages (e.g., eBay Fashion Outlet).

The comparison price is the price of a comparable product sold through non-outlet channels on eBay (or elsewhere), or not specifically made for the outlet.

In fashion, a "comparable" product shares the same design, but is not considered an identical product. Some products are specifically made for outlets, and may have a different SKU than the "comparable" product. These made-for-outlet products may be manufactured in a different place, with different materials, or according to different specifications (i.e. different stitch pattern, seam reinforcement, button quality, etc.)

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .DiscountPriceInfo
  .MadeForOutletComparisonPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Applicable only if the item was specifically made for sale through dedicated eBay outlet pages (e.g., eBay Fashion Outlet).

The comparison price is the price of a comparable product sold through non-outlet channels on eBay (or elsewhere), or not specifically made for the outlet.

In fashion, a "comparable" product shares the same design, but is not considered an identical product. Some products are specifically made for outlets, and may have a different SKU than the "comparable" product. These made-for-outlet products may be manufactured in a different place, with different materials, or according to different specifications (i.e. different stitch pattern, seam reinforcement, button quality, etc.)

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item
  .DiscountPriceInfo
  .MinimumAdvertisedPrice
AmountType (double) Conditionally Minimum Advertised Price (MAP) is an agreement between suppliers (or manufacturers (OEM)) and the retailers (sellers) stipulating the lowest price an item is allowed to be advertised at. Sellers can offer prices below MAP by means of other discounts. This only applies to fixed-price listings and auction listings with the Buy It Now option.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .DiscountPriceInfo
  .MinimumAdvertisedPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Minimum Advertised Price (MAP) is an agreement between suppliers (or manufacturers (OEM)) and the retailers (sellers) stipulating the lowest price an item is allowed to be advertised at. Sellers can offer prices below MAP by means of other discounts. This only applies to fixed-price listings and auction listings with the Buy It Now option.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item
  .DiscountPriceInfo
  .MinimumAdvertisedPriceExposure
MinimumAdvertisedPriceExposureCodeType Conditionally For MinimumAdvertisedPrice (MAP) listings only. A seller cannot show the actual discounted price on eBay's View Item page. Instead, the buyer can either click on a pop-up on eBay's View Item page, or the discount price will be shown during checkout.

Applicable values:

CustomCode
(in/out) Reserved for future use.
DuringCheckout
(in/out) This enumeration value indicates that the discounted price will only be shown to the buyer once the buyer reaches the eBay Checkout page. To enable this pricing treatment when adding/revising/relisting an item, include the DiscountPriceInfo.MinimumAdvertisedPriceExposure field in an Add/Revise/Relist calls and set its value to DuringCheckout.
None
(in/out) The value None is no longer valid. If provided in the request, it will be mapped to PreCheckout.
PreCheckout
(in/out) This enumeration value indicates that the buyer must add the item to his/her cart before the discounted price can be displayed. To enable this pricing treatment when adding/revising/relisting an item, include the DiscountPriceInfo.MinimumAdvertisedPriceExposure field in an Add/Revise/Relist calls and set its value to PreCheckout.

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

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .DiscountPriceInfo
  .OriginalRetailPrice
AmountType (double) Conditionally The actual retail price set by the manufacturer (OEM). eBay does not maintain or validate the OriginalRetailPrice supplied by the seller. OriginalRetailPrice should always be more than StartPrice. Compare the StartPrice/BuyItNowPrice to OriginalRetailPrice to determine the amount of savings to the buyer.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .DiscountPriceInfo
  .OriginalRetailPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The actual retail price set by the manufacturer (OEM). eBay does not maintain or validate the OriginalRetailPrice supplied by the seller. OriginalRetailPrice should always be more than StartPrice. Compare the StartPrice/BuyItNowPrice to OriginalRetailPrice to determine the amount of savings to the buyer.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item
  .DiscountPriceInfo
  .PricingTreatment
PricingTreatmentCodeType Conditionally Based on OriginalRetailPrice, MinimumAdvertisedPrice, and StartPrice values, eBay identifies whether the listing falls under MAP or STP (aka OriginalRetailPrice). GetItem returns this for items listed with one of these discount pricing treatments. GetSellerList returns the DiscountPriceInfo container. This field is not applicable for Add/Revise/Relist calls.
Default: false.

Applicable values:

CustomCode
(out) Reserved for future use.
MAP
(out) This enumeration value indicates that Minimum Advertised Pricing is enabled for the order line item. If this value is returned, the minimum advertised price is found in the MinimumAdvertisedPrice field.
MFO
(out) This enumeration value indicates that Made For Outlet Comparison Pricing is enabled for the order line item. If this value is returned, the Made For Outlet Comparison price is found in the MadeForOutletComparisonPrice field.
None
(out) This enumeration value indicates that neither Strikethrough Pricing or Minimum Advertised Pricing is enabled for the order line item.
STP
(out) This enumeration value indicates that Strikethrough Pricing is enabled for the order line item. If this value is returned, the price in the OriginalRetailPrice field will be crossed out in the View Item page.

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

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .DiscountPriceInfo.SoldOffeBay
boolean Conditionally Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on a Web site or offline store other than eBay in the previous 30 days. The discount price is always in reference to the seller's own price for the item.

If this field is set to true, eBay displays 'Was*' in the UK and 'Ursprunglich*' in Germany, next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields are set to true, SoldOneBay takes precedence.

Default: false.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .DiscountPriceInfo.SoldOneBay
boolean Conditionally Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on eBay within the previous 30 days. The discount price is always in reference to the seller's own price for the item.

If this field is set to true, eBay displays 'Was' in the UK and 'Ursprunglich' in Germany, next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields are set to true, SoldOneBay takes precedence.

Default: false.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.eBayPlus boolean Conditionally eBay Plus is a premium account option for buyers, which provides benefits such as fast and free domestic shipping, and free returns on selected items. To offer this feature to buyers, sellers must opt in to eBay Plus, and their selling status must be 'Above Standard' or above.

Note: Currently, eBay Plus is only available to buyers on the Germany and Australia marketplaces, and this field should only be used by sellers selling eligible items in Germany.

In Australia, the seller has no control/responsibility over setting the eBay Plus feature for a listing. Instead, eBay will evaluate/determine whether a listing is eligible for eBay Plus. Due to this fact, an Australian seller will also get the 21919431: This listing isn't eligible for eBay Plus. warning message in an add/revise/relist call, even though eBay may ultimately set the eBay Plus feature on the listing if the item is eligible.

In an add/revise/relist call, a seller on the Germany site must include this field and set its value to true. If the seller is not eligible for/opted in to eBay Plus and/or the listing category or item does not qualify for eBay Plus, a warning message will be returned to the seller in the response indicating this. In addition to the seller, listing category, and item being eligible for eBay Plus, the seller must also set/commit to the following for the listing:
  • Listing format must be fixed-price.
  • Same-day or one-day handling (DispatchTimeMax set to 0 or 1).
  • A free, next-day shipping option offered.
  • A return policy that offers a 30-day (or longer) return period.
If this field is returned as true in a 'Get' call, it indicates that the item is eligible for eBay Plus treatment, but eBay Plus will only come into play if the buyer is subscribed to eBay Plus.

See:
    Bay Plus for more details
    Selling with eBay Plus (Australia help page)

ItemArray.Item
  .eBayPlusEligible
boolean Conditionally If this field is returned as true, this item is eligible to be listed under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast and free domestic shipping and free returns on selected items. eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Among other requirements, sellers must commit to next-day delivery of those items.

Note: Currently, eBay Plus is available only to buyers in Germany and Australia marketplaces.

See eBay Plus for more details.

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 This containers consists of fields that allows the seller of a Classified Ad listing to tell potential buyers what days and times they may be contacted to inquire about the listing.

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.

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

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.

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

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 The unique identifier for a secondary category that eBay has added as a free promotion. You cannot add this yourself. This container is only returned if the item was listed in a single category and eBay added a free secondary category.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .FreeAddedCategory.CategoryID
string Conditionally This string value is the unique identifier of an eBay category. In GetItem and related calls, see the CategoryName field for the text name of the category. The parent category of this eBay category is only shown in GetCategories.
Note: When listing in categoryID 173651 (Auto Performance Tuning Devices & Software), use of catalog products is required. For more information, see Tuning devices and software. In an Add call, the PrimaryCategory.CategoryID is conditionally required unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, item specifics, listing category, and stock photo defined in the catalog product is used to create the listing.

In an Add/Revise/Relist call, the SecondaryCategory.CategoryID is conditionally required if a Secondary Category is used. Using a Secondary Category can incur a listing fee.

For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field.

Max length: 10.

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

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.HideFromSearch boolean Conditionally This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
ItemArray.Item.HitCount long Conditionally This value indicates the number of page views that a listing has received in the last 30 days.

We recommend that you use the getTrafficReport method of the Analytics API to return user traffic details received by a seller's listings. This RESTful method returns metrics such as click-through rate, listing impressions, listing views, sales conversion rate, and the number of completed transactions.

Note: This field is only returned to authorized applications.

DetailLevel: ReturnAll.

GranularityLevel: Fine.
ItemArray.Item
  .IntegratedMerchantCreditCardEnabled
boolean Conditionally This field is no longer applicable as eBay sellers can no longer use iMCC gateway accounts to handle buyer payments.
Note: This field will stop being returned in order management calls on January 31, 2024.

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 a seller will be converting an existing eBay listing into the new Inventory model using the bulkMigrateListings call of the Inventory API, the InventoryTrackingMethod value must be set to ItemID (default value), but the item must also have a SKU value (Item.SKU or Variation.SKU) associated with it. For GetItem and related calls: Only returned when the value is SKU; not returned when the value is ItemID.


Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
ItemID
(in/out) Indicates the seller prefers to track the listing by its eBay item ID. This is the default for all listings.
SKU
(in/out) Indicates the seller prefers to track the listing by their own SKU.

When you track by SKU, it means you can pass in 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.

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

DetailLevel: ItemReturnDescription, ReturnAll.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

ItemArray.Item
  .IsSecureDescription
boolean Conditionally This boolean field indicates whether or not the listing description is HTTPS secure/compliant. To be HTTPS secure/compliant, the Item.Description field may not contain any links to site pages that use the HTTP (and not HTTPS) protocol. This field will be returned with each listing that is found unless one or more OutputSelector fields are used and Item.IsSecureDescription is not one of the values passed in to one of these fields.

If this field is returned as true, the listing is HTTPs secure/compliant, and the whole listing description will appear on the View Item page for the listing. If this field is returned as false, the listing is not HTTPs secure/compliant, and only a partial/brief listing description will appear on the View Item page for the listing, with a link to the full listing description that will load in another tab.

If the listing description is not HTTPS compliant, the fix is to call ReviseItem or ReviseFixedPriceItem and update the Item.Description field, removing all links to HTTP pages.

For more information about why eBay made this change, please see the Policy Updates page of the Fall 2017 Seller Updates page.
ItemArray.Item.ItemID ItemIDType (string) Conditionally The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified.

Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. Your code should be prepared to handle IDs of up to 19 digits.

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

In an Add/Revise/Relist call, this container is used to set the Best Offer Auto-Accept and Best Offer Auto-Decline threshold values.

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.)
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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 at or above this value, the offer is automatically accepted by the seller. This applies only to items listed in categories that support the BestOfferAutoAcceptPrice feature.

For this setting to have an effect, the Best Offer feature must be enabled for the listing, and only the seller who listed the item will see BestOfferAutoAcceptPrice in a call response.

For Revise and Relist calls: If a seller wanted to disable the Best Offer Auto-Accept and/or Best Offer Auto-Reject feature when revising or relisting an item, the full path to one or both of these two corresponding fields would be provided in a DeletedField tag, like the following:
 Item.ListingDetails.BestOfferAutoAcceptPrice 


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 at or above this value, the offer is automatically accepted by the seller. This applies only to items listed in categories that support the BestOfferAutoAcceptPrice feature.

For this setting to have an effect, the Best Offer feature must be enabled for the listing, and only the seller who listed the item will see BestOfferAutoAcceptPrice in a call response.

For Revise and Relist calls: If a seller wanted to disable the Best Offer Auto-Accept and/or Best Offer Auto-Reject feature when revising or relisting an item, the full path to one or both of these two corresponding fields would be provided in a DeletedField tag, like the following:
 Item.ListingDetails.BestOfferAutoAcceptPrice 


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.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine, Medium.
ItemArray.Item.ListingDetails
  .CheckoutEnabled
boolean Conditionally Indicates whether or not the seller's Checkout Enabled preference is turned on.
Note: A 'Checkout Enabled' setting is no longer available to sellers, and this field is always returned as true. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine, Medium.
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.
Note: The ListingDetails.ConvertedBuyItNowPrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024.

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.
Note: The ListingDetails.ConvertedBuyItNowPrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024.

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.
Note: The ListingDetails.ConvertedReservePrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024.

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.
Note: The ListingDetails.ConvertedReservePrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024.

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.
Note: The ListingDetails.ConvertedStartPrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024.

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.
Note: The ListingDetails.ConvertedStartPrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024.

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.
Note: The HasPublicMessages field will stop being returned in GetItemTransactions and GetSellerTransactions, on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ListingDetails
  .HasReservePrice
boolean Conditionally If true, the seller specified a value in ReservePrice.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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. This applies only to items listed in categories that support the Best Offer auto-decline feature.

In order for this setting to have an effect, Best Offer must be enabled for the listing, and this value will only be exposed to the seller who listed the item.

For Revise and Relist calls: If a seller wanted to disable the Best Offer auto-accept and/or Best Offer auto-reject feature when revising or relisting an item, the full path to one or both of these two corresponding fields would be provided in a DeletedField tag, like the following:
 Item.ListingDetails.MinimumBestOfferPrice 

Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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. This applies only to items listed in categories that support the Best Offer auto-decline feature.

In order for this setting to have an effect, Best Offer must be enabled for the listing, and this value will only be exposed to the seller who listed the item.

For Revise and Relist calls: If a seller wanted to disable the Best Offer auto-accept and/or Best Offer auto-reject feature when revising or relisting an item, the full path to one or both of these two corresponding fields would be provided in a DeletedField tag, like the following:
 Item.ListingDetails.MinimumBestOfferPrice 

Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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 will reflect the last relist.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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
  .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).
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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 ?. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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.

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.

Note: As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions:
  • The following eBay Motors US categories are exempt from this change: Cars & Trucks (6001), Motorcycles (6024), Other Vehicles & Trailers (6038), Boats (26429), Powersports (66466).
  • All child categories under Cars, Motorcycles & Vehicles (9800) categories on the eBay UK and eBay Italy sites are also exempt from this change.
If any other listing duration value besides GTC is specified in this field, it will be ignored, and GTC will be used instead.


DetailLevel: ItemReturnDescription, ReturnAll.

Applicable values: See ListingDurationCodeType
ItemArray.Item
  .ListingEnhancement
ListingEnhancementsCodeType Conditionally,
repeatable: [0..*]
Describes listing upgrades that sellers can select for a fee, such as the BoldTitle upgrade.

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

Applicable values:

BoldTitle
(in/out) This value is used if the seller wants the listing title to be in boldface type. This feature will incur a listing fee. Note that this enhancement will not put the listing subtitle in boldface type (if a subtitle is used).
CustomCode
(in/out) Reserved for internal or future use.

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

DetailLevel: ItemReturnDescription, ReturnAll.
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) This value indicates that the lead generation listing is a classifed ad. Note that only some eBay categories support classified ad listings. Use the GetCategoryFeatures call (with FeatureID value set to AdFormatEnabled) to see which categories support classified ad listings.
CustomCode
(in/out) Reserved for internal or future use
LocalMarketBestOfferOnly
(in/out) This value indicates that the lead generation listing is a US Motors Local Market listing. Note that only some eBay Motors categories support Motors Local Market listings. Use the GetCategoryFeatures call (with the SITEID header set to 100 and the FeatureID value set to LocalMarketAdFormatEnabled) to see which eBay Motors categories support Motors Local Market listings.

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

DetailLevel: ItemReturnDescription, ReturnAll.

See:
    About Local Market Listings
    Advertising with Classified Ads

ItemArray.Item.ListingType ListingTypeCodeType Conditionally The selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value).

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

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

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

Applicable values:

AdType
(in/out) This enumeration value represents a classified ad in a Real Estate category. This listing type is only used to solicit inquiries from interested parties. 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.

Although listing durations may vary by eBay marketplace and category, typical listing durations for real estate ads are 30 and 90 days. It is recommended that the seller uses the GetCategoryFeatures call to retrieve the actual listing durations that are supported for real estate ads on a particular marketplace and category.
Chinese
(in/out) This value indicates an auction listing. In an auction listing, prospective buyers engage in a competitive bidding process, although Buy It Now may be offered as long as no bids have been placed. Auctions occur on the eBay marketplace site, and the auction listings will also appear in the seller's eBay Store (if the seller has an eBay Store).

Although listing durations may vary by eBay marketplace and category, typical listing durations for auctions are 3, 5, 7, and 10 days. It is recommended that the seller uses the GetCategoryFeatures call to retrieve the actual listing durations that are supported for auctions on a particular marketplace and category.
CustomCode
(in/out) Reserved for internal or future use.
FixedPriceItem
(in/out) With this listing format, the selling is offering the item at a fixed price, although it is still possible for the seller to negotiate the price with prospective buyers using the Best Offer feature. A fixed-price listing can offer a single item, or if the seller has multiple quantity of the same item, multiple quantity of that same item can be made available for sale through the same listing. Additionally, the seller can set up a multiple-variation, fixed-price listing, where similar items can be sold through the same listing. An example of a multiple-variation, fixed-price listing might be a t-shirt (or another article of clothing) that is available in multiple color and size combinations.

Traditionally, listing durations for fixed-prices listings have varied by eBay marketplace and category. Typical listing durations for fixed-price listings ranged from three to 30 days, or GTC (Good 'Til Cancelled). As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions:
  • The following eBay Motors US categories are exempt from this change: Cars & Trucks (6001), Motorcycles (6024), Other Vehicles & Trailers (6038), Boats (26429), Powersports (66466).
  • All child categories under Cars, Motorcycles & Vehicles (9800) categories on the eBay UK and eBay Italy sites are also exempt from this change.

With the 'GTC' listing duration, the listing will remain active as long as the listing shows that inventory is available for purchase (available quantity is '1' or more). For sellers listing motor vehicles on the eBay US Motors, eBay UK, or eBay Italy sites, it is recommended that the seller uses the GetCategoryFeatures call to retrieve the supported listing durations for their particular marketplace and category.

Note: As long as a fixed-price listing has inventory available, or if the out-of-stock control feature is being used, GTC listings are automatically renewed each month according to the calendar day.
LeadGeneration
(in/out) This enumeration value represents a (non-Real Estate) classified ad listing. The AdType enumeration value represents Real Estate classified ads. This listing type is only used to solicit inquiries from interested parties. 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. Non-Real Estate classified ads are only available in a limited number of eBay categories, including Business and Industrial categories, Travel, ans Specialty Services.

Although listing durations may vary by eBay marketplace and category, typical listing durations for (non-Real Estate) classified ads are 30, 60, and 90 days. It is recommended that the seller uses the GetCategoryFeatures call to retrieve the actual listing durations that are supported for real estate ads on a particular marketplace and category.

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

See Listing types.

ItemArray.Item.Location string Conditionally Indicates the geographical location of the item (along with the value in the Country field). 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. If you specify a postal code, but do not specify a location, then the location is given a default value derived from the postal code.

For the Classified Ad format for motors vehicle listings, the value provided in the Location field 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.

Max length: 45.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.PaymentMethods BuyerPaymentMethodCodeType Conditionally,
repeatable: [0..*]

For Add/Revise/Relist calls: A PaymentMethods field is required for each offline payment method supported by the seller for the listing.
Note: Sellers no longer have to specify any electronic payment methods for listings, so one or more PaymentMethods fields will only be needed for listings that require/support payments off of eBay's platform. If an electronic payment is supplied in a PaymentMethods field, a warning will be triggered and the payment method will be dropped. Note: If you are already referencing a payments business policy in an Add/Revise/Relist call with the SellerProfiles.SellerPaymentProfile container, no PaymentMethods fields will be needed, as these settings will already be set in the payments business policy. Payment methods are not applicable to any classified ad listings, as any agreement and payment is handled off of the eBay platform.

For Get calls that return PaymentMethods fields : One or more PaymentMethods fields will only be returned if the seller set one or more offline payment methods for the listing.
Note: This field will stop being returned in order management calls on January 31, 2024.

Applicable values:

CashOnPickup
(in/out) This enumeration value indicates that cash on pickup is accepted for payment. This value is only applicable for offline payments.
CustomCode
(in/out) Reserved for internal or future use.
MOCC
(in/out) This enumeration value indicates that a money order or cashiers check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces.
PersonalCheck
(in/out) This enumeration value indicates that a personal check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces.

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item
  .PickupInStoreDetails
PickupInStoreDetailsType Conditionally This container is used in Add/Revise/Relist/Verify listing calls by the seller to enable a listing with the 'In-Store Pickup' feature. The 'In-Store Pickup' feature is only available to a limited number of large retail merchants in the US, Canada, UK, Germany, and Australia marketplaces.

This container is returned in the 'Get' calls if the listing is enabled with the In-Store Pickup feature.
ItemArray.Item
  .PickupInStoreDetails
  .EligibleForPickupDropOff
boolean Conditionally For sellers opted in to Click and Collect, this field was once used to set Click and Collect eligibility at the listing level. However, now the seller can only opt in to Click and Collect at the account level, and then each of their listings will be automatically evaluated by eBay for Click and Collect eligibility.

Note: Until this field is fully deprecated in the Trading WSDL (and in Add/Revise/Relist/Verify calls), it can still be used, but it will have no functional affect. However, if set in an Add/Revise/Relist/Verify call, it will get returned in GetItem, but it won't be a true indicator if the item is actually available for the Click and Collect fulfillment method. Instead, the Item.AvailableForPickupDropOff field should be referenced to see if the listing actually has inventory that is available for pickup via the Click and Collect fulfillment method.
ItemArray.Item
  .PickupInStoreDetails
  .EligibleForPickupInStore
boolean Conditionally For Add/Revise/Relist/Verify calls: this field is included 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. In-Store Pickup as a fulfillment method is only available to a limited number of large retail merchants in the US, Canada, UK, Germany, and Australia marketplaces. The In-Store Pickup feature can only be applied to multiple-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/Verify call to enable the In-Store Pickup option on a multiple-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 API, sellers can associate physical stores to their account by using the Create Inventory Location call, and then, using the Create Inventory Item call, they can add inventory to specific stores;
  • 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 multiple-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.
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.

This field is returned in the 'Get' calls if the listing is enabled with the In-Store Pickup feature.
ItemArray.Item.PictureDetails PictureDetailsType Conditionally This container consists of the data associated with photos within the listing. Sellers can have up to 24 pictures in almost any category at no cost. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors). These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol.

It is required that all listings have at least one picture.

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

See:
    Add pictures
    Adding photos to your listing

ItemArray.Item.PictureDetails
  .GalleryType
GalleryTypeCodeType Conditionally This field is used to specify the type of picture gallery to use for the listing. If this field is omitted, a standard picture gallery is used for the listing. There is no listing fee for a standard picture gallery.

To use the Gallery Plus feature, you must include this field and set its value to Plus.

The Gallery image will be the first URL passed into the first PictureURL field, so if you want a specific picture to be the Gallery image, you should make sure you pass the URL for this picture in the first PictureURL field.

When revising a listing, if you disable the Gallery Plus feature by including the GalleryType field and setting its value to Gallery, the original feature fee for this feature will not be credited to the seller.


Applicable values:

CustomCode
(in/out) Reserved for internal use only.
Gallery
(in/out) This feature, which is free on all sites, adds a Gallery image in the search results. A Gallery image is an image that was uploaded and copied to EPS (eBay Picture Service). This copy is stored for 30 days or until the image is associated with a listing. Once the image is associated with a listing, the period is extended to 90 days after the item's sale_end date and is extended again if the item is relisted or used in subsequent listings. As part of storing a copy, EPS also makes additional sizes available (thumbnail, main image, supersize, popup, etc.), which are used by the various Gallery enhancements.

All images must comply to the Picture Requirements.
None
(in/out) Gallery is supported free on all sites. So this field is useful only for removing an existing feature setting when using RelistItem.
Plus
(in/out) Adds a Gallery Plus icon to the listing.

When Plus is selected in a request that specifies at least two images (using ItemType.PictureDetailsType.PictureURL), the Gallery Plus feature automatically includes a Gallery Showcase of all the listing's images.

The Gallery Showcase displays when hovering over or clicking on the listing's Gallery Plus icon in the search results. The Showcase window displays a large (400px x 400px) preview image which is first image specified PictureURL, as well as up to 11 (64 px x 64 px) selectable thumbnails for the remaining EPS images. Clicking on the preview image displays the item's listing page.

If Plus is selected and the request includes only one EPS image or any self-hosted images, the listing includes a Gallery Plus icon that, when hovered over or clicked, displays a large (400px x 400px) preview image of the item. Clicking the image displays the View Item page for that listing.

When using RelistItem or ReviseItem (item has no bids and more than 12 hours before the listing's end), Plus can be unselected in the request. However, the Plus fee will still apply if a previous request selected Plus. There is at most one Plus fee per listing.

When "Plus" is included in an item listing, the listing also automatically gets the Gallery functionality at no extra cost. "Gallery" does not need to be specified separately in the listing.

Listing images that are originally smaller than 400px x 400px are centered in the preview frame. Images that are originally larger than 400px x 400px are scaled down to 400px on their longest side (maintaining their original aspect ratio).

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.PrimaryCategory CategoryType Conditionally This container is used in an Add/Revise/Relist call to set the primary listing category. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, listing category, and stock photo defined in the catalog product is used to create the listing.

Once you determine the appropriate eBay category for your product, and want to know which listing features it supports, you can use the GetCategoryFeatures call. To discover required, recommended, and optional Item Specifics for a category, use the getItemAspectsForCategory method of the Taxonomy API.

If you do use an eBay catalog product, it is advised that you do not include this field, as any primary category ID you specify in this field may get dropped if this category is different than the primary category defined in the eBay catalog product.

For ReviseItem only: When revising a listing, you can change the primary category only if an auction listing has no bids or a multiple-quantity, fixed-price listing has no sales, and the listing does not end within 12 hours. If you change the listing category, any Item Specifics that were previously specified may be dropped from the listing if they aren't valid for the new category.

When you list an event ticket on the US site, you must specify one of the leaf categories under the Tickets & Experiences meta category.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    Applying Categories
    Maintaining Category Data

ItemArray.Item.PrimaryCategory
  .CategoryID
string Conditionally This string value is the unique identifier of an eBay category. In GetItem and related calls, see the CategoryName field for the text name of the category. The parent category of this eBay category is only shown in GetCategories.
Note: When listing in categoryID 173651 (Auto Performance Tuning Devices & Software), use of catalog products is required. For more information, see Tuning devices and software. In an Add call, the PrimaryCategory.CategoryID is conditionally required unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, item specifics, listing category, and stock photo defined in the catalog product is used to create the listing.

In an Add/Revise/Relist call, the SecondaryCategory.CategoryID is conditionally required if a Secondary Category is used. Using a Secondary Category can incur a listing fee.

For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field.

Max length: 10.

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

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.PrivateListing boolean Conditionally A true value in this field indicates that the listing is private. Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users.

For ReviseItem/ReviseFixedPriceItem: The seller will not be able change this setting if the listing has any pending bids, any pending best offers, previous sales (for multiple-quantity, fixed-price listing), or if the listing will end within 12 hours.


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

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

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

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

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

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

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

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits.

DetailLevel: ItemReturnDescription, ReturnAll.

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

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

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.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item
  .ReasonHideFromSearch
ReasonHideFromSearchCodeType Conditionally This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.

Applicable values:

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

This enumeration value is associated with eBay Duplicate Listings Policy, which is applicable on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read eBay's Duplicate Listings Policy help page.
OutOfStock
(out) This value indicates that the listing is currently hidden from search because the quantity in the listing is zero. However, the listing is still alive and will reappear in the search results when the quantity is set to something greater than zero. The 'Out-of-stock' option is set by the seller at the account level. This option can be enabled in My eBay Site Preferences, or the seller can use the OutOfStockControlPreference field in the SetUserPreferences call.

Code so that your app gracefully handles any future changes to this list.
ItemArray.Item.ReservePrice AmountType (double) Conditionally This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder.

As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit.

In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See:
    Revise a US eBay motors listing
    Setting a reserve price (eBay help topic)
    Fees for optional listing upgrades (eBay help topic)

ItemArray.Item.ReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder.

As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit.

In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ReturnPolicy ReturnPolicyType Conditionally Describes the seller's return policy. Most categories on most eBay sites require the seller to clearly specify whether or not returns are accepted (see ReturnsAcceptedOption).
Note: As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the ReturnPolicy container or through a return business policy that is referenced through the SellerProfiles.SellerReturnProfile container.
Note: If you are using a return business policy set up through My eBay or via the Account API, then you should not populate the fields in this ReturnPolicy container. Instead, indicate your return policy using the SellerProfiles.SellerReturnProfile container.

However, if you do not configure a return policy, all the fields in this ReturnPolicy container that are marked conditional must be populated in your request.

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

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.

Note: The GeteBayDetails call can be used to retrieve site-wide return policy metadata, but it is recommended that sellers use the GetCategoryFeatures call instead, as this call was recently updated to retrieve category-level metadata for both domestic and international return policies.
Note: In May 2018, eBay added the ability to create a separate international return policy for items that are shipped to international customers. If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead for international returns. For more information on setting separate domestic and international return policies, see the International returns policy help topic. For the international equivalent of this field, see the InternationalRefundMethodValues field.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See Specify a return policy.

ItemArray.Item.ReturnPolicy
  .Description
string Conditionally This field contains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. This field is valid in only the following marketplaces (the field is otherwise ignored):
  • Germany (DE)
  • Austria (AT)
  • France (FR)
  • Italy (IT)
  • Spain (ES)
Where valid, sellers can use this field to add details about their return policies. eBay uses this text string as-is in the additional details 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: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Max length: 8000 (for DE, AT); 5000 (for FR, IT, ES).

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReturnPolicy
  .InternationalRefundOption
token Conditionally This field indicates how the seller compensates international buyers for returns. MoneyBack is the only supported value for all marketplaces except for the US. On the US marketplace, you can set this value to either MoneyBack or MoneyBackOrReplacement. MoneyBackOrReplacement can be used by sellers that have the depth of inventory to support an exchange for an identical item. However, ultimately, it is up to the buyer on whether they want money back or a replacement item.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, the refund option(s) for international returns will default to the value specified in the RefundOption field.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See International Refund Methods (in GetCategoryFeatures) for supported international refund value for each site and category.



Applicable values: See RefundOptionsCodeType
ItemArray.Item.ReturnPolicy
  .InternationalReturnsAcceptedOption
token Conditionally This field is conditionally required if a seller wants to use a separate return policy for international returns. The value in this field indicates whether or not the seller accepts returns from international buyers.

Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows international buyers to return items. Specify ReturnsNotAccepted for a listing if returns are not accepted from international buyers.

On the eBay DE, IE, and UK, registered 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. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, the return accepted value for international returns will default to the value specified in the ReturnsAcceptedOption field.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See International Returns Accepted Values (in GetCategoryFeatures) for supported international returns accepted values for each site and category.



Applicable values: See ReturnsAcceptedOptionsCodeType
ItemArray.Item.ReturnPolicy
  .InternationalReturnsWithinOption
token Conditionally This field is conditionally required if a seller is using a separate return policy for international returns, and is accepting international returns. The value in this field indicates the number of days that an international buyer has to return an item. The time period begins on the day that the buyer receives the item. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing.

Applicable values: Retrieve the values supported by a marketplace and category by calling GetCategoryFeatures with FeatureID set to InternationalReturnsDurationValues, then see the values returned under the Category.InternationalReturnsDurationValues container in the response.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts international returns (InternationalReturnsAcceptedOption is set to ReturnsAccepted) but does not specify this field for a listing, eBay sets a default value (often Days_30) and the seller is obligated to honor this setting.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, the return period for international returns will default to the value specified in the ReturnsWithinOption field.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See International Return Durations (in GetCategoryFeatures) for supported international return durations for each site and category.



Applicable values: See ReturnsWithinOptionsCodeType
ItemArray.Item.ReturnPolicy
  .InternationalShippingCostPaidByOption
token Conditionally This field is conditionally required if a seller is using a separate return policy for international returns, and is accepting international returns. The value in this field specifies whether the buyer or the seller pays for international return shipping charges. Accepted values are Buyer or Seller. eBay sites often set Seller as the default value for this field, and sellers are obligated to honor the values that are set for a listing.

Depending on the seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues or for late shipments.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, return shipping cost payee for international returns will default to the value specified in the ShippingCostPaidByOption field.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See Return Shipping Cost Payee Values (in GetCategoryFeatures) for supported international return shipping cost payee values for each site and category.



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

This field is applicable to only the US marketplace and is not applicable as input to the Add/Revise/Relist family of calls. (Use RefundOption instead.)

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReturnPolicy
  .RefundOption
token Conditionally This field indicates how the seller compensates buyers for returns. MoneyBack is the only supported value for all marketplaces except for the US. On the US marketplace, you can set this value to either MoneyBack or MoneyBackOrReplacement. MoneyBackOrReplacement can be used by sellers that have the depth of inventory to support an exchange for an identical item. However, ultimately, it is up to the buyer on whether they want money back or a replacement item.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalRefundOption field.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See Domestic Refund Methods (in GetCategoryFeatures) for supported domestic refund value for each site and category.



Applicable values: See RefundOptionsCodeType
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 This required field indicates whether or not the seller accepts returns.

Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows items to be returned. Specify ReturnsNotAccepted for a listing if returns are not accepted.

On the eBay DE, IE, and UK marketplaces, registered 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. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response.

Note: In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for their items (ReturnsAcceptedOption = ReturnsAccepted) and handling time should be set to zero-day (same-day shipping) or one-day shipping. Set the handling time (in days) using the Item.DispatchTimeMax field.
For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalReturnsAcceptedOption field.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See Domestic Returns Accepted Values (in GetCategoryFeatures) for supported domestic returns accepted values for each site and category.



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 Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted.

Applicable values: Retrieve the values supported by a marketplace and category by calling GetCategoryFeatures with FeatureID set to DomesticReturnsDurationValues, then see the values returned under the Category.DomesticReturnsDurationValues container in the response.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalReturnsWithinOption field.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See Domestic Return Durations (in GetCategoryFeatures) for supported domestic return durations for each site and category.



Applicable values: See ReturnsWithinOptionsCodeType
ItemArray.Item.ReturnPolicy
  .ShippingCostPaidBy
string Conditionally This is a 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 This option specifies whether the buyer or the seller pays for return shipping charges. Accepted values are Buyer or Seller. eBay sites often set Seller as the default value for this field, and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted.

Depending on the seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues or for late shipments.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalShippingCostPaidByOption field.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See Return Shipping Cost Payee Values (in GetCategoryFeatures) for supported domestic return shipping cost payee values for each site and category.



Applicable values: See ShippingCostPaidByOptionsCodeType
ItemArray.Item.ReviseStatus ReviseStatusType Conditionally This container is returned if a listing has been revised in any way since it first became active. One or more boolean fields will be returned under this container based on the type of revision(s) that occured, including a general revision, a price change, or a feature added or removed.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ReviseStatus
  .ItemRevised
boolean Conditionally This field is returned as true if the original listing has been revised. This field is always returned with the ReviseStatus container.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .SecondaryCategory
CategoryType Conditionally The unique identifier for a secondary category. This field is only applicable if the seller decides to list the item under two categories.

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 listing category as a value category (see ValueCategory in GetCategoryFeatures), and that listing category will be the seller's primary category, the seller will not be able to list their item in a secondary category. If a seller's request payload includes a primary or a secondary category that is designated as a value category, then eBay drops the SecondaryCategory ID and only lists the item in the category specified with the PrimaryCategory ID. Also, if the listing request includes Item Specifics (in ItemSpecifics) that are associated with the SecondaryCategory, eBay drops those values as well when the SecondaryCategory is dropped. 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 within 12 hours of the listing's scheduled end time, you can only add or change the secondary category when an auction listing has no active bids or a multiple-quantity, fixed-price listing has no items sold. If you change the secondary category, any corresponding Item Specifics that were previously specified may be dropped from the listing if they aren't valid for the category.

For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .SecondaryCategory.CategoryID
string Conditionally This string value is the unique identifier of an eBay category. In GetItem and related calls, see the CategoryName field for the text name of the category. The parent category of this eBay category is only shown in GetCategories.
Note: When listing in categoryID 173651 (Auto Performance Tuning Devices & Software), use of catalog products is required. For more information, see Tuning devices and software. In an Add call, the PrimaryCategory.CategoryID is conditionally required unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, item specifics, listing category, and stock photo defined in the catalog product is used to create the listing.

In an Add/Revise/Relist call, the SecondaryCategory.CategoryID is conditionally required if a Secondary Category is used. Using a Secondary Category can incur a listing fee.

For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field.

Max length: 10.

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

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item
  .SellerContactDetails
AddressType Conditionally This container is used by sellers of Classified Ad listings to provide contact information.

DetailLevel: ItemReturnDescription, ReturnAll.

See Classified ad listings.

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

If business policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request.
Note: To make sure that the shipping cost override and policies are set correctly on an item (that is using business policies and has one or more shipping service cost overrides set up), the Item.SellerProfiles.SellerShippingProfile container and the Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride container(s) must be included, even if no changes are being made. This container is only returned in 'Get' calls if business policies are set for the listing, and the person making the API call is the seller of the listing.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SellerProfiles
  .SellerPaymentProfile
SellerPaymentProfileType Conditionally The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify API call to reference and use the settings/values of a payment business policy. Payment business policies contain a setting to control whether immediate payment is required, settings to specify due dates for the deposit and full payment of a motor vehicle listing (Motors policy only), and settings to specify which offline payment methods are avaiable to buyers for sales transactions that happen off of eBay's platform. Multiple payment business policies can be created and saved at the account level by sellers.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.

Note: Sellers will never have to specify electronic payment methods, but offline payment methods are required for listings where offline payment is required or supported.

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

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

In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy.

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

In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SellerProfiles
  .SellerReturnProfile
SellerReturnProfileType Conditionally The SellerReturnProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a return business policy. Return business policies contain detailed information on the seller's return policy for domestic and international buyers (if the seller ships internationally), including whether or not the seller accepts returns from domestic and international buyers, how many days the buyer has to return the item for a refund, and who pays the return shipping costs. Multiple return policy business policies can be created and saved at the account level by sellers.
Note: As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the ReturnPolicy container or through a return business policy that is referenced through the SellerProfiles.SellerReturnProfile container.

This container is only returned in 'Get' calls if Business Policies are set for the listing and the person making the API call is the seller of the listing.

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

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

In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy.

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

In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.SellerProfiles
  .SellerShippingProfile
SellerShippingProfileType Conditionally The SellerShippingProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a specific shipping business policy. Shipping business policies contain detailed information on domestic and international shipping, including shipping service options and costs, handling time, shipping discount information, and excluded ship-to locations. Multiple shipping business policies can be created and saved at the account level by sellers.
Note: Any shipping inclusions specified through this container can be overridden by the eBay International Shipping exclusions toggle located under Shipping Preferences in My eBay. For more information on eBay International Shipping, see eBay International Shipping program. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.

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

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

In the 'Get' calls, the ShipppingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShipppingProfileName value will be returned if a name is assigned to the shipping business policy.

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

In the 'Get' calls, the ShippingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the shipping business policy.

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

DetailLevel: 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: GetItem returns an error (invalid item ID) in the response if Item.SellingStatus.AdminEnded = 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
A value of true indicates that the user has set up an About Me page.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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 Anonymous user information.

ItemArray.Item.SellingStatus
  .HighBidder.BuyerInfo
  .ShippingAddress
AddressType Conditionally This container shows the buyer's shipping address.

Note: For an Authenticity Guarantee program order returned in GetItemTransactions or GetSellerTransactions, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer's shipping address.

Note: For In-Store Pickup and Click and Collect orders, this is the address of the merchant's store where the buyer will pick up the order. This is only applicable for GetItemTransactions and GetSellerTransactions calls.

Note: For eBay Vault scenarios: GetItemTransactions calls, and GetSellerTransactions calls (Seller View only), mock address details are returned for:

- Vault to vault orders: Buyer and Seller View

- Ship to vault orders: Mock addresses are returned for the Buyer View (only); the address returned for the Seller View will be the authenticator&apos;s address.

- Vault in-hand submission orders: the address returned for the Buyer View will be the authenticator's address (GetItemTransactions only).

The following address details are returned for mock addresses:

 <ShippingAddress> 
 <Name>eBay Vault</Name>
 <AddressID>Invalid Request</AddressID>
 <AddressOwner>eBay</AddressOwner>
 <AddressUsage>Invalid</AddressUsage>
 <CityName>Invalid Request</CityName>
 <Country>US</Country>
 <CountryName>Invalid Request</CountryName>
 <ExternalAddressID>Invalid Request</ExternalAddressID>
 <Phone>Invalid Request</Phone>
 <PostalCode>Invalid Request</PostalCode>
 <StateOrProvince>Invalid Request</StateOrProvince>
 <Street1>Invalid Request</Street1>
 <Street2></Street2>
</ShippingAddress>



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.



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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.BuyerInfo
  .ShippingAddress.PostalCode
string Conditionally User's postal code.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.eBayGoodStanding
boolean Conditionally
This boolean field is returned as true if the eBay user is in good standing with eBay.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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 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 GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
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:
    Anonymous user information
    Member communications

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). 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 Anonymous user information.

ItemArray.Item.SellingStatus
  .HighBidder.FeedbackRatingStar
FeedbackRatingStarCodeType Conditionally
A visual indicator of an eBay user's Feedback score. A different colored star is used for each range of Feedback scores. See FeedbackRatingStarCodeType for specific values.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

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.

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See 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: Protecting your account
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.SellingStatus
  .HighBidder.NewUser
boolean Conditionally This boolean is returned as true if the eBay user has been registered on eBay for 30 days or less.
Note: The Buyer.NewUser field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Anonymous user information.

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

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

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

Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the 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 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.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Anonymous user information.

ItemArray.Item.SellingStatus
  .HighBidder.UserIDLastChanged
dateTime Conditionally
Date and time when the user last changed their eBay user ID (in GMT).
Note: The Buyer.UserIDLastChanged field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See 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

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Vat-exempt sellers.

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 transaction fees. This processing can take several minutes.
  • If you retrieve a sold item and no details about the buyer/high bidder are returned or no transaction fees are 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. 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 should be considered accurate and complete. In this state, all transaction fees should be calculated.
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 should be considered accurate and complete. However, the transaction fees are not yet available.

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

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.

Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, none of the fields under the ShippingDetails container are necessary. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container.

If you do not use a fulfillment business policy, many of the fields under this ShippingDetails container become required in your request.
Note: For ReviseItem and ReviseFixedPriceItem calls: If you are updating any field under the ShippingDetails container, you must include all containers and fields set under this container even if their values are not changing. If you do not do this, some fields may be removed from the listing. To find out the values included in the current listing, call GetItem and look through the ShippingDetails container in the response. For additional information, see Revise shipping details. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired.

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

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

Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
  • Either omit the entire ShippingDetails container, or pass in an empty ShippingDetails container - <ShippingDetails/>
  • Pass in one ShipToLocations field, with its value set to None - <ShipToLocations>None</ShipToLocations>

For GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    Shipping costs
    Revising Items for restrictions on changing item properties with ReviseItem

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.

Note: The CalculatedShippingRate container should only be used to specify values for the InternationalPackagingHandlingCosts and/or PackagingHandlingCosts fields. The rest of the fields in the CalculatedShippingRate container are used to specify package dimensions and package weight, and these values should now be specified in the ShippingPackageDetails container instead.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
AmountType (double) Conditionally This field shows any package handling cost applied to international shipping. This cost will be in addition to any shipping cost applicable to each international shipping service option.

For international calculated shipping only.
ItemArray.Item.ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
  [ attribute currencyID ]
CurrencyCodeType Conditionally This field shows any package handling cost applied to international shipping. This cost will be in addition to any shipping cost applicable to each international shipping service option.

For international calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
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.
Note: If the listing only has one domestic shipping service and it is free shipping, the domestic package handling cost will be ignored and will not be applied to the listing.

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.
Note: If the listing only has one domestic shipping service and it is free shipping, the domestic package handling cost will be ignored and will not be applied to the listing.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ShippingDetails
  .ExcludeShipToLocation
string Conditionally,
repeatable: [0..*]
Use this field in an Add/Revise/Relist call 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.

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.

Note: The ShipToLocations and ShippingDetails.ExcludeShipToLocation containers are not applicable for motor vehicle listings on the US, CA, or UK marketplaces. If these containers are sent in the request, they are ignored and a warning is returned. Note: Any shipping exclusions specified by this field can be overridden by the eBay International Shipping exclusions toggle located under Shipping Preferences in My eBay. For more information on eBay International Shipping, see eBay International Shipping program.
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: This field will stop being returned in GetItemTransactions and GetSellerTransactions responses on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.

Applicable values: See CountryCodeType, ShippingRegionCodeType
ItemArray.Item.ShippingDetails
  .GlobalShipping
boolean Conditionally Note: The Global Shipping Program (GSP) is only available on the UK marketplace. On the US marketplace, the Global Shipping Program was replaced by the intermediated international shipping program called eBay International Shipping.

eBay International Shipping is an account level setting, and no field will need to be set in a add/revise call to enable this setting. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available. Even if the US seller is opted into eBay International Shipping, that same seller can still also specify individual international shipping service options through the ShippingDetails.InternationalShippingServiceOption container.
In an Add/Revise/Relist call, this boolean field can be included and set to True if the seller would like to use eBay's Global Shipping Program for orders that are shipped internationally.

In 'Get' calls, if this field is returned as True, it indicates that international shipping through the Global Shipping Program is available for the listing. If this field is returned as False, the seller is responsible for shipping the item internationally using one of the specified international shipping service options set for the listing.

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



DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
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 or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping or eBay International 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 or eBay International Shipping) from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.

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

DetailLevel: ItemReturnDescription, ReturnAll.

See Repeating (unbounded) fields 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 if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

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

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

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

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

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

See https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/shipping-types-rates.html.

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

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

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

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

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

For a list of possible enumeration values, see CurrencyCodeType.
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. If the Global Shipping Program is enabled on the listing for international shipping, only four additional shipping services may be specified.

If this field is omitted from international shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call.

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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, ShipToLocation fields will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, ShipToLocation fields are only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

DetailLevel: ItemReturnDescription, ReturnAll.

See Shipping information.



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

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .RateTableDetails
RateTableDetailsType Conditionally This container is used to reference and apply a seller's domestic and/or international shipping rate tables to a listing. Shipping rate tables allow sellers to configure specific shipping costs based on the shipping destinations and level of service (e.g. economy, standard, expedited, and one-day). Generally speaking, sellers want to use these shipping rate tables so they can charge a higher shipping cost to the buyer whenever shipping costs are higher for them as well. For example, shipping to Alaska or Hawaii is generally more expensive than shipping to any other of the 48 US states, or in regards to international shipping, shipping to some regions and countries are more expensive than others.

Sellers configure domestic and international shipping rate tables in My eBay Shipping Preferences. To apply shipping rate tables to a listing, the shipping cost type must be flat-rate.

For domestic shipping rate tables, the three supported domestic regions are Alaska & Hawaii, US Protectorates (e.g. Puerto Rico and Guam), and APO/FPO destinations, which are US military bases/locations outside of the continental US. In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package, or they can add a surcharge instead. To determine if a domestic shipping rate table is set up for the seller's account, the GetUser call can be used, and then the seller will look for a value of true in the User.SellerInfo.DomesticRateTable field. Although the GetUser call can be used to see if a domestic shipping rate table exists for the seller's account, details of the shipping rate table, including all specified costs for the different regions, can only be viewed and modified in My eBay Shipping Preferences. This functionality is not yet available in any public APIs.

For international shipping rate tables, specific rates may be set up for any and all of the nine geographical regions and individual countries within those regions. Similar to domestic shipping rate tables, the seller has the option of adding an extra charge based on the weight of the shipping package. Sellers cannot add a surcharge for international shipping. To determine if a international shipping rate table is set up for the seller's account, the GetUser call can be used, and then the seller will look for a value of true in the User.SellerInfo.InternationalRateTable field. Although the GetUser call can be used to see if an international shipping rate table exists for the seller's account, details of the shipping rate table, including all specified costs for the different regions/countries, can only be viewed and modified in My eBay Shipping Preferences. This functionality is not yet available in any public APIs.

If you are applying a domestic or international shipping rate table that specifies a surcharge by weight, you must specify the item weight in the ShippingPackageDetails container's WeightMajor and WeightMinor fields, even though the listing is using flat-rate shipping. Do not use any other fields in the ShippingPackageDetails container because none of those fields are applicable in this use case.

This container is only returned in the 'Get' calls if one or more shipping rate tables have been applied to the listing, and if the call is being made by the seller who listed the item.

Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, Canada (English and French), Italy, UK, and Germany sites. For other sites, only one domestic and one international shipping rate table may be set up per seller. Whether a seller is using the old default domestic and international shipping rate tables or the new shipping rate tables, these shipping rate tables are set up in My eBay Shipping Preferences or as part of a Shipping Business Policy. If using the Trading API to create a listing that will use the new shipping rate tables, the DomesticRateTableId and InternationalRateTableId fields are used to reference and apply these new shipping rate tables to the listing. If desired, sellers can still use the old default shipping rate tables, but they are not allowed to mix and match old and new shipping rate tables, meaning that they will get an error if they pass in both the old fields (DomesticRateTable and InternationalRateTable) and the new fields (DomesticRateTableId and InternationalRateTableId). The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).

DetailLevel: ItemReturnDescription, ReturnAll.

See Shipping rate tables for more information on using shipping rate tables..

ItemArray.Item.ShippingDetails
  .RateTableDetails
  .DomesticRateTable
string Conditionally This field is used in an Add/Revise/Relist/Verify call to apply the domestic shipping rate table to the listing.

In all cases, sellers pass in a string value of Default to apply the domestic shipping rate table. The shipping rates and/or surcharges set up in the domestic shipping rate table will only be applicable based on the location of the buyer, and if that shipping service level is covered in one of the specified shipping service options in the listing. Basically, domestic shipping costs and surcharges are set in one or more ShippingServiceOptions containers in the listing, and based on the settings and costs in the domestic shipping rate table, these shipping costs and/or surcharges may be overridden based on the buyer's location. For example, if the buyer lives in Alaska, and the domestic shipping rate table has one or more shipping rates set up for the Alaska & Hawaii domestic region, the buyer will see these rates in the View Item page and not the rates/costs that are defined in the ShippingServiceOptions containers.

If a seller is revising or relisting an item, the domestic shipping rate table can be unassociated from the listing by using the empty tag: <DomesticRateTable />

This field is returned in the 'Get' calls if a domestic rate table is being applied to the listing, and it is only returned for the seller who listed the item.

Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, Canada (English and French), Italy, UK, and Germany sites. Currently, for sites other than the ones stated, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the DomesticRateTable and InternationalRateTable tags and pass in Default as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId tags, and the DomesticRateTable and InternationalRateTable tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).
Max length: 50.

DetailLevel: ItemReturnDescription, ReturnAll.

See Shipping rate tables for more information on using shipping rate tables..

ItemArray.Item.ShippingDetails
  .RateTableDetails
  .DomesticRateTableId
string Conditionally Note: This field is only available for sellers on the US, Australia, Canada (English and French), Italy, UK, and Germany sites. The unique shipping rate identifiers that will be passed into this field can be retrieved using the getRateTables call of the Account API, or these identifiers can be viewed in the displayed URL when the seller selects a specific shipping rate table in the Shipping rate tables UI in My eBay.
This field is included in an Add/Revise/Relist/Verify call if the seller wants to apply a customized domestic shipping rate table to the listing. The string value that is supplied in this field is the unique identifier of the shipping rate table. If the DomesticRateTableId field is used, the seller must make sure that the DomesticRateTable and InternationalRateTable fields are not used, as the old and new rate tables cannot be used together or an error will occur.

In domestic shipping rate tables, sellers customize the flat-rate cost of shipping based on shipping destination (region/state/province) and shipping service level (one-day, expedited, standard, economy in US). In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package, or they can add a surcharge instead.

If the seller is using the Revise or Relist call, they must include the DomesticRateTableId field or the domestic shipping rate table currently being applied to the listing will be unassociated from the listing. If they want to continue using the same domestic shipping rate table, the seller will pass in this identifier. The seller can also change the domestic shipping rate table by passing in the identifier for a different domestic shipping rate table.

If a seller is revising or relisting an item, the domestic shipping rate table can be unassociated from the listing by using the empty tag: <DomesticRateTableId />

This field is returned in the 'Get' calls if a customized domestic rate table is being applied to the listing, and it is only returned for the seller who listed the item.

Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, Canada (English and French), Italy, UK, and Germany sites. For other sites, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the DomesticRateTable and InternationalRateTable tags and pass in Default as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId tags, and the DomesticRateTable and InternationalRateTable tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).
Max length: 50.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .RateTableDetails
  .InternationalRateTable
string Conditionally This field is used in an Add/Revise/Relist/Verify call to apply the international shipping rate table to the listing. International shipping rate tables can be used only for items listed on the eBay US, UK, and DE sites.

In all cases, sellers pass in a string value of Default to apply the international shipping rate table. The shipping rates set up in the international shipping rate table will only be applicable based on the location of the buyer, and if that shipping service level is covered in one of the specified international shipping service options in the listing. Basically, international shipping costs are set in one or more InternationalShippingServiceOption containers in the listing, and based on the settings and costs in the international shipping rate table, these shipping costs may be overridden based on the buyer's location. For example, if the buyer lives in Argentina, and the international shipping rate table has one or more shipping rates set up for the country of Argentina, the buyer will see these rates in the View Item page and not the rates/costs that are defined in the InternationalShippingServiceOption containers.

If a seller is revising or relisting an item, the international shipping rate table can be unassociated from the listing by using the empty tag: <InternationalRateTable />

This field is returned in the 'Get' calls if an international rate table is being applied to the listing, and it is only returned for the seller who listed the item.

Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, Canada (English and French), Italy, UK, and Germany sites. Currently, for sites other than the ones stated, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the DomesticRateTable and InternationalRateTable tags and pass in Default as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId tags, and the DomesticRateTable and InternationalRateTable tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).
Max length: 50.

DetailLevel: ItemReturnDescription, ReturnAll.

See Shipping rate tables for more information on using shipping rate tables..

ItemArray.Item.ShippingDetails
  .RateTableDetails
  .InternationalRateTableId
string Conditionally Note: This field is only available to sellers on the US, Australia, Canada (English and French), Italy, UK, and Germany sites. The unique shipping rate identifiers that will be passed into this field can be retrieved using the getRateTables call of the Account API, or these identifiers can be viewed in the displayed URL when the seller selects a specific shipping rate table in the Shipping rate tables UI in My eBay.
This field is included in an Add/Revise/Relist/Verify call if the seller wants to apply a customized international shipping rate table to the listing. The string value that is supplied in this field is the unique identifier of the shipping rate table. If the InternationalRateTableId field is used, the seller must make sure that the DomesticRateTable and InternationalRateTable fields are not used, as the old and new rate tables cannot be used together or an error will occur.

In international shipping rate tables, sellers customize the flat-rate cost of shipping based on shipping destination (continent/region/country) and shipping service level (expedited, standard, economy in US). In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package. Unlike domestic shipping, sellers cannot add a surcharge for international shipping.

If the seller is using the Revise or Relist call, they must include the InternationalRateTableId field or the international shipping rate table currently being applied to the listing will be unassociated from the listing. If they want to continue using the same international shipping rate table, the seller will pass in this identifier. The seller can also change the international shipping rate table by passing in the identifier for a different international shipping rate table.

If a seller is revising or relisting an item, the domestic shipping rate table can be unassociated from the listing by using the empty tag: <InternationalRateTableId />

This field is returned in the 'Get' calls if a customized international rate table is being applied to the listing, and it is only returned for the seller who listed the item.

Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, Canada (English and French), Italy, UK, and Germany sites. For other sites, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the DomesticRateTable and InternationalRateTable tags and pass in Default as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId tags, and the DomesticRateTable and InternationalRateTable tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).
Max length: 50.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .SalesTax
SalesTaxType Conditionally This container shows sales tax information for an item in a specific tax jurisdiction. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites.

This container can be used in an Add/Revise/Relist/Verify call to set sales tax settings for a specific tax jurisdiction, but it is actually a better practice if a user sets up sales tax rates through the Sales Tax Table tool in My eBay (or by using the SetTaxTable call). A seller's Sales Tax Table is applied to the listing by including the UseTaxTable field in the request and setting its value to true. The GetTaxTable call can be used to retrieve the current sales tax rates for different tax jurisdictions.

This container is only returned in order management 'Get' calls if sales tax is applicable to the order line item. For eBay Collect and Remit states, the sales tax information is displayed in the Transaction.Taxes container instead.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).


DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Multi-jurisdiction sales tax.

ItemArray.Item.ShippingDetails
  .SalesTax.SalesTaxPercent
float Conditionally This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction (US state or Canadian province). Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

This field is only returned in order management calls if sales tax applies to the order line item, and is only in GetItem (and other 'Get' calls) if sales tax is applicable to the listing or order line item, and the seller is the person making the call.

Although this field will be returned at the order level in order management calls for a single line item order, sales tax is applied at the line item level and not order level. For multiple line item orders, this field will not be returned at all at the order level.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).


DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.ShippingDetails
  .SalesTax.SalesTaxState
string Conditionally This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all two-digit identifiers for all states/territories/provinces for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction. Please note that both GetTaxTable and GeteBayDetails calls use a JurisdictionID field to express these tax jurisdiction identifiers instead of SalesTaxState, but the values used in these fields are the same.

The SalesTaxState field is conditionally required in an Add/Revise/Relist/Verify call if the seller is applying sales tax to a listing for a particular jurisdiction, and is returned with each SalesTax container to identify the tax jurisdiction.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .SalesTax
  .ShippingIncludedInTax
boolean Conditionally This field is included in an Add/Revise/Relist/Verify call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified.

This field is always returned with the SalesTax container (whether true or false).

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).


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..*]
This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required.

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

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


If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well.

To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.

A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping shipment or eBay International Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

Note: If the seller has set the shipping cost model to 'Flat' or 'Calculated' (ShippingDetails.ShippingType field), at least one actual shipping service option must be specified through a ShippingServiceOptions container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingService value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup.
For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

DetailLevel: ItemReturnDescription, ReturnAll.

See Repeating (unbounded) fields 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 This field is returned as true if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingService
token Conditionally This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container.

For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

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

Note: The eBay standard envelope (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards, and to coins & paper money, postcards, stamps, patches, and similar eligible categories, and is only available on the US marketplace. See eBay standard envelope for details, restrictions, and an envelope size template. To use this service, send envelopes using the USPS mail and set the ShippingService field to US_eBayStandardEnvelope.

For the REST equivalent, see Using the eBay standard envelope (eSE) 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 if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

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

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

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

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
AmountType (double) Conditionally The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

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.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

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

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

If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMax
int Conditionally The integer value returned here indicates the maximum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

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

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMin
int Conditionally The integer value returned here indicates the minimum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

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

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


DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.ShippingDetails
  .TaxTable.TaxJurisdiction
TaxJurisdictionType Conditionally,
repeatable: [0..*]
In a SetTaxTable, a TaxJurisdiction container is required for each tax jurisdiction that the seller wishes to make additions/changes. Sales tax details for zero or more jurisdictions (states, provinces, etc). This can be just one jurisdiction, up to all jurisdictions defined for the site's country. Any values specified through a TaxJurisdiction container will override any existing values defined in the seller's Sales Tax Table.

If GetTaxTable is called without the DetailLevel field, only tax jurisdictions where sales tax rates have been set up are returned. However, if the DetailLevel field is included in the request and set to ReturnAll, all tax jurisdictions are returned, regardless of whether or not the seller has modified settings for any/all of these jurisdictions.

This container is only returned in order-related 'Get' calls if sales tax is applicable to the order line item.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).


DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.ShippingDetails
  .TaxTable.TaxJurisdiction
  .JurisdictionID
string Conditionally This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all JurisdictionID values for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction.

The JurisdictionID field is always required in a SetTaxTable call, and always returned with each TaxJurisdiction container to identify the tax jurisdiction.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ShippingDetails
  .TaxTable.TaxJurisdiction
  .SalesTaxPercent
float Conditionally This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction. Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

This field is only returned in GetTaxTable (and other 'Get' calls) if a sales tax percentage rate has been set.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ShippingDetails
  .TaxTable.TaxJurisdiction
  .ShippingIncludedInTax
boolean Conditionally This field is included in a SetTaxTable call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified.

This field is always returned with each TaxJurisdiction container (whether true or false).

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ItemArray.Item.ShippingDetails
  .ThirdPartyCheckout
boolean Conditionally
Note: This field is deprecated and will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
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 shipping business policy 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 shipping business policy.
Note: To make sure that the shipping cost override and policies are set correctly on an item (that is using business policies and has one or more shipping service cost overrides set up), the Item.SellerProfiles.SellerShippingProfile container and the Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride container(s) must be included, even if no changes are being made. 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 shipping business policy.

For Revise and Relist calls: To delete all shipping service cost overrides when you revise or relist, specify Item.ShippingServiceCostOverrideList in DeletedField, and don't pass ShippingServiceCostOverrideList in the request.
ItemArray.Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
ShippingServiceCostOverrideType Conditionally,
repeatable: [0..*]
A ShippingServiceCostOverride container is required for each domestic and/or international shipping service option, defined in the domesticShippingPolicyInfoService and intlShippingPolicyInfoService containers of the Business Policies shipping profile, that the seller wishes to override the shipping costs. 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 service options in the Business Policies shipping profile.

To override the shipping costs for any domestic shipping service option in the Business Policies shipping profile, the ShippingServiceType field should be set to 'Domestic', and to override the shipping costs for any international shipping service option, 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 GetItem, and GetSellerList calls.
ItemArray.Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally This dollar value indicates the cost to ship each additional identical item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding shippingServiceAdditionalCost value set in the domesticShippingPolicyInfoService (domestic shipping service) or intlShippingPolicyInfoService (international shipping service) containers in the Business Policies shipping profile.

This field is only applicable to multi-quantity, fixed-price listings.
ItemArray.Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally This dollar value indicates the cost to ship each additional identical item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding shippingServiceAdditionalCost value set in the domesticShippingPolicyInfoService (domestic shipping service) or intlShippingPolicyInfoService (international shipping service) containers in the Business Policies shipping profile.

This field is only applicable to multi-quantity, fixed-price listings.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingServiceCost
AmountType (double) Conditionally This dollar value indicates the shipping service cost to ship one item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding shippingServiceCost value set in the domesticShippingPolicyInfoService (domestic shipping service) or intlShippingPolicyInfoService (international shipping service) containers in the Business Policies shipping profile.
ItemArray.Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally This dollar value indicates the shipping service cost to ship one item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding shippingServiceCost value set in the domesticShippingPolicyInfoService (domestic shipping service) or intlShippingPolicyInfoService (international shipping service) containers in the Business Policies shipping profile.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingServicePriority
int Conditionally This integer value maps the particular instance of the ShippingServiceCostOverride container to the domesticShippingPolicyInfoService or intlShippingPolicyInfoService container of the Business Policies shipping profile. The ShippingServicePriority value should match the sortOrderId value for the matching shipping service in the Business Policies shipping profile. If overriding the shipping costs for a domestic shipping service, the ShippingServiceType field should be set to 'Domestic', and to override the shipping costs for an international shipping service, the ShippingServiceType field should be set to 'International'.

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.
ItemArray.Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingServiceType
ShippingServiceType Conditionally This enumerated value indicates whether the shipping costs of a domestic or an international shipping costs are being overridden. To override the shipping costs for any domestic shipping service in the Business Policies shipping profile, this field should be set to 'Domestic', and to override the shipping costs for any international shipping service, this field should be set to 'International'.

Applicable values:

Domestic
(in/out) This value should be used if the seller is overriding shipping costs for all domestic shipping services defined in the Business Policies shipping profile.
International
(in/out) This value should be used if the seller is overriding shipping costs for all international shipping services defined in the Business Policies shipping profile.

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

Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, the ShipToLocations field should not be used in the request. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container.
Use GeteBayDetails with a DetailName of ShippingLocationDetails to determine which international locations are valid for the site. 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.

Note: The ShipToLocations and ShippingDetails.ExcludeShipToLocation containers are not applicable for motor vehicle listings on the US, CA, or UK marketplaces. If these containers are sent in the request, they are ignored and a warning is returned.
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).

Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
  • Either omit the entire ShippingDetails container, or pass in an empty ShippingDetails container - <ShippingDetails/>
  • Pass in one ShipToLocations field, with its value set to None - <ShipToLocations>None</ShipToLocations>


DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.

See:
    Shipping information
    GeteBayDetails



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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

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

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

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

If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request.

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

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

Max length: 50.

DetailLevel: ItemReturnDescription, ReturnAll.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

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

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

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

GetMyeBaySelling does not return Item.StartPrice for fixed price items—it returns Item.SellingStatus.CurrentPrice.

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

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

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Listing Policies.

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

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

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

GetMyeBaySelling does not return Item.StartPrice for fixed price items—it returns Item.SellingStatus.CurrentPrice.

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

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

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.Storefront StorefrontType Conditionally This container provides details about the seller's eBay store.

In an Add/Revise/Relist call, the seller can include this container to set/change which customized eBay store category that the item will be placed in.

For 'Get' calls, this container is returned if the seller of the item has an eBay store.

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Coarse, Fine, Medium.
ItemArray.Item.Title string Conditionally This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing.

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

The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.
Note: When making a GetSellerEvents call, this field will be returned masked as ***************** for on-hold listings. Note: When making a GetSellerTransactions or GetMyeBaySelling call, the item ID value of the listing will be returned in this field to indicate that the listing is on hold.
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 similar (but not identical) items in a multiple-variation, fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one order line item can contain multiple items from a single variation.)

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

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

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

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

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

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

For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling: Only returned when a listing has variations and HideVariations was set to false or not specified in the request.
Note: This container will stop being returned in GetItemTransactions on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.

See Multiple-variation listings.

ItemArray.Item.Variations
  .Variation
VariationType Conditionally,
repeatable: [0..*]

Contains data that distinguishes one item variation from another. For example, if an item varies by color and size, each Variation node specifies a combination of one of those colors and sizes.

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll.

See Multiple-variation listings.

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

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

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

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

For GetSellerTransactions: See Item.Quantity instead.

See the Trading API User 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 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.
Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.

See:
    Set and adjust a variation's quantity
    Out-of-Stock control

ItemArray.Item.Variations
  .Variation.SellingStatus
SellingStatusType Conditionally Contains the variation's quantity sold. Always returned when variations are present.
Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024.

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: GetItem returns an error (invalid item ID) in the response if Item.SellingStatus.AdminEnded = 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
A value of true indicates that the user has set up an About Me page.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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 Anonymous user information.

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.BuyerInfo
  .ShippingAddress
AddressType Conditionally This container shows the buyer's shipping address.

Note: For an Authenticity Guarantee program order returned in GetItemTransactions or GetSellerTransactions, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer's shipping address.

Note: For In-Store Pickup and Click and Collect orders, this is the address of the merchant's store where the buyer will pick up the order. This is only applicable for GetItemTransactions and GetSellerTransactions calls.

Note: For eBay Vault scenarios: GetItemTransactions calls, and GetSellerTransactions calls (Seller View only), mock address details are returned for:

- Vault to vault orders: Buyer and Seller View

- Ship to vault orders: Mock addresses are returned for the Buyer View (only); the address returned for the Seller View will be the authenticator&apos;s address.

- Vault in-hand submission orders: the address returned for the Buyer View will be the authenticator's address (GetItemTransactions only).

The following address details are returned for mock addresses:

 <ShippingAddress> 
 <Name>eBay Vault</Name>
 <AddressID>Invalid Request</AddressID>
 <AddressOwner>eBay</AddressOwner>
 <AddressUsage>Invalid</AddressUsage>
 <CityName>Invalid Request</CityName>
 <Country>US</Country>
 <CountryName>Invalid Request</CountryName>
 <ExternalAddressID>Invalid Request</ExternalAddressID>
 <Phone>Invalid Request</Phone>
 <PostalCode>Invalid Request</PostalCode>
 <StateOrProvince>Invalid Request</StateOrProvince>
 <Street1>Invalid Request</Street1>
 <Street2></Street2>
</ShippingAddress>



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.



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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.BuyerInfo
  .ShippingAddress.PostalCode
string Conditionally User's postal code.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.eBayGoodStanding
boolean Conditionally
This boolean field is returned as true if the eBay user is in good standing with eBay.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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 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 GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
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:
    Anonymous user information
    Member communications

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). 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 Anonymous user information.

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.FeedbackRatingStar
FeedbackRatingStarCodeType Conditionally
A visual indicator of an eBay user's Feedback score. A different colored star is used for each range of Feedback scores. See FeedbackRatingStarCodeType for specific values.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

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.

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See 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: Protecting your account
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.
ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.NewUser
boolean Conditionally This boolean is returned as true if the eBay user has been registered on eBay for 30 days or less.
Note: The Buyer.NewUser field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Anonymous user information.

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

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

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

Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the 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 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.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Anonymous user information.

ItemArray.Item.Variations
  .Variation.SellingStatus
  .HighBidder.UserIDLastChanged
dateTime Conditionally
Date and time when the user last changed their eBay user ID (in GMT).
Note: The Buyer.UserIDLastChanged field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See 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

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

DetailLevel: ItemReturnDescription, ReturnAll.

GranularityLevel: Fine.

See Vat-exempt sellers.

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 transaction fees. This processing can take several minutes.
  • If you retrieve a sold item and no details about the buyer/high bidder are returned or no transaction fees are 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. 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 should be considered accurate and complete. In this state, all transaction fees should be calculated.
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 should be considered accurate and complete. However, the transaction fees are not yet available.

Code so that your app gracefully handles any future changes to this list.
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 a seller-defined identifier. It is only intended for the seller's use (not for buyers). A SKU value is not required, but many large sellers like to add SKU value to their listings. If defined on a listing, a SKU value can be used by sellers to reconcile their eBay inventory with your own inventory system, instead of using the VariationSpecifics identifying values.

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 include the Item.InventoryTrackingMethod field in an 'FixedPriceItem' call and set its value to SKU, the Variation.SKU values become required for each variation..

For GetItem, GetOrders and other 'Get' calls: Only returned if the seller specified a SKU for the variation.
Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024.
Max length: 80.

DetailLevel: ItemReturnDescription, ReturnAll.

See SKU identifiers.

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

Each variation requires this field, and the prices can be the same for all variations, or 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.
Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.

See Pricing.

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

Each variation requires this field, and the prices can be the same for all variations, or 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.
Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024.

For a list of possible enumeration values, see CurrencyCodeType.
ItemArray.Item.Variations
  .Variation
  .VariationProductListingDetails
VariationProductListingDetailsType Conditionally This container is used to provide one or more product identifiers for a product variation within a multiple-variation, fixed-price listing. The same product identifier type(s) must be used for all product variations within the listing. For instance, if one product variation uses ISBNs, all product variations must use ISBN values.

When you include the VariationProductListingDetails container in a call, you must specify at least one GTIN or ePID. If an ePID is provided, a matching eBay catalog product must exist for the value that is passed in.

For ReviseItem and RelistItem only: When you revise a listing, if it ends within 12 hours, you cannot change the product identifier and you cannot remove existing product variation listing details data.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Variations
  .Variation
  .VariationProductListingDetails
  .EAN
string Conditionally This field is used if the seller wants to, or is required to identify each product variation within a multiple-variation listing by an EAN (European Article Number) value. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products. The seller can use the GetCategoryFeatures call to see if an EAN is supported/required for a category.

Note: If the listing is being posted to a category that expects EAN values, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, ProductDetails should be included as a DetailName value in the call request.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Variations
  .Variation
  .VariationProductListingDetails
  .ISBN
string Conditionally This field is used if the seller wants to, or is required to identify each product variation within a multiplge-variation listing by an ISBN (International Standard Book Number) value. An ISBN is a unique identifer for books. Both 10 and 13-character ISBNs are supported. When specifying a 13-character ISBN, the value must begin with either '978' or '979'. The seller can use the GetCategoryFeatures call to see if an ISBN is supported/required for a category.

Note: If the listing is being posted to a category that expects ISBN values, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, ProductDetails should be included as a DetailName value in the call request.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Variations
  .Variation
  .VariationProductListingDetails
  .UPC
string Conditionally This field is used if the seller wants to, or is required to identify each product variation within a multiple-variation listing by a UPC (Universal Product Code) value. A UPC is a commonly-used identifier for many different products. The seller can use the GetCategoryFeatures call to see if a UPC is supported/required for a category.

Note: If the listing is being posted to a category that expects UPC values, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, ProductDetails should be included as a DetailName value in the call request.

DetailLevel: ItemReturnDescription, ReturnAll.
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 Item Specific names, but each variation must provide a unique combination of values for those Item Specific names. For example, if the items vary by color and size, then every variation must specify 'Color' and 'Size' as Item Specific names, but 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 of Variationpecifics by using the Variations.ModifyNameList container. 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, Variationpecifics are not returned if the variation has a SKU. If the variation has no SKU, then Variationpecifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force Variationpecifics to be returned, even when the SKU is returned.
Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024.

DetailLevel: ItemReturnDescription, ReturnAll.

See:
    Configure variation-selection widgets for buyers (View Item)
    Revise and relist 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 variations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node.
When you list with Item Variations:
  • Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
  • Specify up to five VariationSpecifics in each Variation node.
  • Specify all applicable names with all their supported values in the VariationSpecificSet node.
See the Variation sample in the AddFixedPriceItem call reference for examples.

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

For AddToWatchList and RemoveFromWatchList: The ItemID value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required.

Note: As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
  • The name of at least one listed chemical that prompted the warning
  • Text stating that the product 'can expose you to' the chemical(s) in the product
  • The URL for OEHHA's new Proposition 65 warnings website, which is www.P65Warnings.ca.gov
Unlike standard item specifics that allow a maximum of 65 characters in the Value field, the matching value for the 'California Prop 65 Warning' item specific allows up to 800 characters of text. When a seller passes in this item specific, eBay will automatically insert a warning symbol icon for the listing.



DetailLevel: ItemReturnDescription, ReturnAll.
ItemArray.Item.Variations
  .Variation.VariationSpecifics
  .NameValueList.Name
string Conditionally Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name.

For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, the value in this field will either be the name of a required/recommended/optional item specific name for the category, or it may be a seller's customized item specific name.

For the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing.

Note: For required and recommended item specifics that are returned in the getItemAspectsForCategory method of the Taxonomy API, the seller should pass in the name of these item specifics just as they are shown in the getItemAspectsForCategory response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the getItemAspectsForCategory response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.

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

For the AddItem family of calls: Multiple values can only be specified for an Item Specific if the itemToAspectCardinality field of the getItemAspectsForCategory method shows a value of MULTI. If an item specific only supports a single value, only the first item specific value specified in the request will be used.

For the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing.

Note: The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. For item specifics with max lengths greater than 65, the actual max length will be returned in a corresponding aspectMaxLength field. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the ItemSpecifics.NameValueList field description.
Max length: 65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning').

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.

DetailLevel: ItemReturnDescription, ReturnAll.
ItemsPerPage int Always This value reflects the value that was set in the Pagination.EntriesPerPage field in the request. This is the maximum number of listings that may be returned per page of the result set. Note that this value is only the maximum threshold and does not necessarily reflect the number of listings appearing on the current page of data.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PageNumber int Always This value indicates the current page of data in the result set that is being displayed. This value reflects the value specified in the Pagination.PageNumber field in the request. Note that page number defaults to 1 if the Pagination.PageNumber field was not included in the request.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PaginationResult PaginationResultType Always This container shows the total number or pages in the result set, as well as the total number of listings that match the current input criteria.

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 This value indicates the total number of listings being shown on the current page of the results set.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Seller UserType Conditionally This container consists of detailed information about the seller and the seller's account. This container is only returned if the GranularityLevel field is included in the request and set to Fine.

GranularityLevel: Fine.
Seller.AboutMePage boolean Always
A value of true indicates that the user has set up an About Me page.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

GranularityLevel: Fine.
Seller.eBayGoodStanding boolean Always
This boolean field is returned as true if the eBay user is in good standing with eBay.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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 GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
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:
    Anonymous user information
    Member communications

Seller.FeedbackPrivate boolean Always Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). 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 Anonymous user information.

Seller.FeedbackRatingStar FeedbackRatingStarCodeType Always
A visual indicator of an eBay user's Feedback score. A different colored star is used for each range of Feedback scores. See FeedbackRatingStarCodeType for specific values.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

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.

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

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

GranularityLevel: Fine.

See Anonymous user information.

Seller.IDVerified boolean Always
Indicates whether the user has been verified. For more information about the ID Verify program, see: Protecting your account
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

GranularityLevel: Fine.
Seller.NewUser boolean Always This boolean is returned as true if the eBay user has been registered on eBay for 30 days or less.
Note: The Buyer.NewUser field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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 Anonymous user information.

Seller.SellerInfo SellerType Always
Contains information about a seller, including listing settings, listing preferences, seller rankings, and seller type.
Note: This container will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

GranularityLevel: Coarse, Fine, Medium.
Seller.SellerInfo
  .AllowPaymentEdit
boolean Always
Indicates whether the seller allows buyers to edit the total cost of an item during checkout.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

GranularityLevel: Fine.
Seller.SellerInfo
  .CIPBankAccountStored
boolean Always
This boolean field indicates whether or not the seller has stored bank account information on file with eBay.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

GranularityLevel: Fine.
Seller.SellerInfo.GoodStanding boolean Always
This boolean field indicates whether or not the seller is in good standing with eBay.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

GranularityLevel: Fine.
Seller.SellerInfo
  .SafePaymentExempt
boolean Always
If this field is true, the user is exempt from the requirement to offer at least one safe payment method when listing items.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
Default: false.

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

GranularityLevel: Fine.
Seller.SellerInfo.SellerLevel SellerLevelCodeType Always
This enumeration value indicates the user's eBay PowerSeller tier.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

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.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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 (look for a value of true in the SellerInfo.StoreOwner field).
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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. Only Top Rated Sellers can qualify for Top Rated Plus listings, which receive the Top Rated Plus seal and other benefits.
This field is only returned for the following sites: US, Germany, Austria, Switzerland, UK, Ireland, and Australia. The Top Rated Seller and Top Rated Plus listing requirements will differ by site. Below are some links to Help pages that discuss these requirements: Top Rated Sellers, registered in the US, can qualify for Top Rated Seller programs in other countries as long as they meet the selling requirements in those countries. However, even if US sellers qualify for programs in other countries, they will not receive the Final Value Fee discount on sales in those countries.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

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

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

GranularityLevel: Fine.

See Anonymous user information.

Seller.Status UserStatusCodeType Always Indicates the user's registration/user status.

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

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

Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the 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 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.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.

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

GranularityLevel: Fine.

See Anonymous user information.

Seller.UserIDLastChanged dateTime Always
Date and time when the user last changed their eBay user ID (in GMT).
Note: The Buyer.UserIDLastChanged field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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

GranularityLevel: Fine.

See 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

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

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

GranularityLevel: Fine.

See Vat-exempt sellers.

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) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

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

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

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

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 This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
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 Error handling section of the Making a Trading API call 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.

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



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.

Please avoid using a DetailLevel of ReturnAll with GetSellerList when possible.

Many item details, such as item descriptions and listing enhancements, are unlikely to change. After an initial request for detailed information about items, subsequent requests can omit the DetailLevel field and thus obtain only the information about items that is likely to change. (Alternatively, consider using GetSellerEvents instead of GetSellerList.) If you need to use ReturnAll to retrieve all details for a set of items, please use a smaller EntriesPerPage value to limit the number of items returned per call. Also, use a shorter time range in EndTimeFrom and EndTimeTo for better performance.

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
HasMoreItemsY-YY
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.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.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.DiscountPriceInfo--(Y)(Y)
ItemArray.Item.DiscountPriceInfo.MadeForOutletComparisonPrice--(Y)(Y)
ItemArray.Item.DiscountPriceInfo.MinimumAdvertisedPrice--(Y)(Y)
ItemArray.Item.DiscountPriceInfo.MinimumAdvertisedPriceExposure--(Y)(Y)
ItemArray.Item.DiscountPriceInfo.OriginalRetailPrice--(Y)(Y)
ItemArray.Item.DiscountPriceInfo.PricingTreatment--(Y)(Y)
ItemArray.Item.DiscountPriceInfo.SoldOffeBay--(Y)(Y)
ItemArray.Item.DiscountPriceInfo.SoldOneBay--(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.HitCount---(Y)
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.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.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.PaymentMethods--(Y)(Y)
ItemArray.Item.PictureDetails(Y)-(Y)(Y)
ItemArray.Item.PictureDetails.GalleryType(Y)-(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.InternationalRefundOption--(Y)(Y)
ItemArray.Item.ReturnPolicy.InternationalReturnsAcceptedOption--(Y)(Y)
ItemArray.Item.ReturnPolicy.InternationalReturnsWithinOption--(Y)(Y)
ItemArray.Item.ReturnPolicy.InternationalShippingCostPaidByOption--(Y)(Y)
ItemArray.Item.ReturnPolicy.Refund--(Y)(Y)
ItemArray.Item.ReturnPolicy.RefundOption--(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.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--(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.CalculatedShippingRate--(Y)(Y)
ItemArray.Item.ShippingDetails.CalculatedShippingRate
  .PackagingHandlingCosts
--(Y)(Y)
ItemArray.Item.ShippingDetails.ExcludeShipToLocation--(Y)(Y)
ItemArray.Item.ShippingDetails.GlobalShipping(Y)(Y)(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.RateTableDetails--(Y)(Y)
ItemArray.Item.ShippingDetails.RateTableDetails.DomesticRateTable--(Y)(Y)
ItemArray.Item.ShippingDetails.RateTableDetails
  .DomesticRateTableId
--(Y)(Y)
ItemArray.Item.ShippingDetails.RateTableDetails
  .InternationalRateTable
--(Y)(Y)
ItemArray.Item.ShippingDetails.RateTableDetails
  .InternationalRateTableId
--(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
  .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.ShippingDetails.ThirdPartyCheckout--(Y)(Y)
ItemArray.Item.ShipToLocations--(Y)(Y)
ItemArray.Item.Site--(Y)(Y)
ItemArray.Item.SKU--(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
  .VariationProductListingDetails
--(Y)(Y)
ItemArray.Item.Variations.Variation
  .VariationProductListingDetails.EAN
--(Y)(Y)
ItemArray.Item.Variations.Variation
  .VariationProductListingDetails.ISBN
--(Y)(Y)
ItemArray.Item.Variations.Variation
  .VariationProductListingDetails.UPC
--(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)
ItemsPerPageY-YY
PageNumberY-YY
PaginationResultY-YY
PaginationResult.TotalNumberOfEntriesY-YY
PaginationResult.TotalNumberOfPagesY-YY
ReturnedItemCountActualY-YY
Seller.AboutMePageY-YY
Seller.eBayGoodStandingY-YY
Seller.Email---(Y)
Seller.FeedbackPrivateY-YY
Seller.FeedbackRatingStarY-YY
Seller.FeedbackScoreY-YY
Seller.IDVerifiedY-YY
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.QualifiesForB2BVATY-YY
Seller.SellerInfo.SafePaymentExemptY-YY
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.

Please avoid using a DetailLevel of ReturnAll with GetSellerList when possible.

Many item details, such as item descriptions and listing enhancements, are unlikely to change. After an initial request for detailed information about items, subsequent requests can omit the DetailLevel field and thus obtain only the information about items that is likely to change. (Alternatively, consider using GetSellerEvents instead of GetSellerList.) If you need to use ReturnAll to retrieve all details for a set of items, please use a smaller EntriesPerPage value to limit the number of items returned per call. Also, use a shorter time range in EndTimeFrom and EndTimeTo for better performance.

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.Country(Y)--
ItemArray.Item.CrossBorderTrade(Y)(Y)(Y)
ItemArray.Item.Currency(Y)(Y)(Y)
ItemArray.Item.HitCount-(Y)-
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.InternationalRefundOption(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.InternationalReturnsAcceptedOption(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.InternationalReturnsWithinOption(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.InternationalShippingCostPaidByOption(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.Refund(Y)(Y)(Y)
ItemArray.Item.ReturnPolicy.RefundOption(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.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.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.ShippingDetails.ThirdPartyCheckout-(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.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.QualifiesForB2BVAT-Y-
Seller.SellerInfo.SafePaymentExempt-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-



Samples

New to making API calls? Please see Making a Call.

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 group of listings that either started or ended during a specified time period.

Description

A seller 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. The seller also chooses to limit the number of listings retrieved per page to two.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetSellerListRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
  <GranularityLevel>Coarse</GranularityLevel> 
  <StartTimeFrom>2019-10-12T21:59:59.005Z</StartTimeFrom> 
  <StartTimeTo>2019-10-26T21:59:59.005Z</StartTimeTo> 
  <IncludeWatchCount>true</IncludeWatchCount> 
  <Pagination> 
    <EntriesPerPage>2</EntriesPerPage> 
  </Pagination> 
</GetSellerListRequest>

Output

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<GetSellerListResponse 
  xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-05T18:28:30.517Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_CORE_APISELLING_19099826_R1</Build>
  <PaginationResult>
    <TotalNumberOfPages>5</TotalNumberOfPages>
    <TotalNumberOfEntries>9</TotalNumberOfEntries>
  </PaginationResult>
  <HasMoreItems>true</HasMoreItems>
  <ItemArray>
    <Item>
      <AutoPay>false</AutoPay>
      <BuyerProtection>ItemIneligible</BuyerProtection>
      <Country>US</Country>
      <Currency>USD</Currency>
      <HitCounter>NoHitCounter</HitCounter>
      <ItemID>1**********7</ItemID>
      <ListingDetails>
        <RelistedItemID>1**********0</RelistedItemID>
        <StartTime>2019-10-13T00:31:36.000Z</StartTime>
        <EndTime>2019-10-20T00:31:36.000Z</EndTime>
        <ViewItemURL>https://www.ebay.com/itm/Brinns-American-Tradition-First-Lady-Gown-Series-Louisa-Johnson-Adams-/1**********7</ViewItemURL>
        <HasUnansweredQuestions>false</HasUnansweredQuestions>
        <HasPublicMessages>false</HasPublicMessages>
        <ViewItemURLForNaturalSearch>https://www.ebay.com/itm/Brinns-American-Tradition-First-Lady-Gown-Series-Louisa-Johnson-Adams-/1**********7</ViewItemURLForNaturalSearch>
      </ListingDetails>
      <ListingDuration>Days_7</ListingDuration>
      <Location>T***y, California</Location>
      <PrimaryCategory>
        <CategoryID>36549</CategoryID>
        <CategoryName>Dolls & Bears:Dolls:By Brand, Company, Character:Other Brand & Character Dolls</CategoryName>
      </PrimaryCategory>
      <Quantity>1</Quantity>
      <ReviseStatus>
        <ItemRevised>false</ItemRevised>
      </ReviseStatus>
      <SellingStatus>
        <BidCount>0</BidCount>
        <BidIncrement currencyID="USD">0.5</BidIncrement>
        <ConvertedCurrentPrice currencyID="USD">8.75</ConvertedCurrentPrice>
        <CurrentPrice currencyID="USD">8.75</CurrentPrice>
        <MinimumToBid currencyID="USD">8.75</MinimumToBid>
        <QuantitySold>0</QuantitySold>
        <SecondChanceEligible>false</SecondChanceEligible>
        <ListingStatus>Completed</ListingStatus>
      </SellingStatus>
      <ShippingDetails>
        <ShippingDiscountProfileID>0</ShippingDiscountProfileID>
        <InternationalShippingDiscountProfileID>*</InternationalShippingDiscountProfileID>
      </ShippingDetails>
      <ShipToLocations>Worldwide</ShipToLocations>
      <Site>US</Site>
      <Storefront>
        <StoreCategoryID>1</StoreCategoryID>
        <StoreCategory2ID>0</StoreCategory2ID>
        <StoreURL>https://stores.ebay.com/a***s</StoreURL>
      </Storefront>
      <TimeLeft>PT0S</TimeLeft>
      <Title>Brinn's American Tradition First Lady Gown Series Louisa Johnson Adams</Title>
      <WatchCount>0</WatchCount>
      <BestOfferDetails>
        <BestOfferCount>0</BestOfferCount>
        <BestOfferEnabled>true</BestOfferEnabled>
        <NewBestOffer>false</NewBestOffer>
      </BestOfferDetails>
      <LocationDefaulted>true</LocationDefaulted>
      <BuyerResponsibleForShipping>false</BuyerResponsibleForShipping>
      <PostalCode>9***1</PostalCode>
      <PictureDetails>
        <GalleryURL>https://i*********.com/*********/***0.jpg</GalleryURL>
        <PhotoDisplay>PicturePack</PhotoDisplay>
        <PictureURL>hhttps://i*********.com/*********/***0.jpg</PictureURL>
        <PictureURL>https://i*********.com/*********/***1.jpg</PictureURL>
        <PictureURL>https://i*********.com/*********/***2.jpg</PictureURL>
        <PictureURL>https://i*********.com/*********/***3.jpg</PictureURL>
      </PictureDetails>
      <ProxyItem>false</ProxyItem>
      <BuyerGuaranteePrice currencyID="USD">20000.0</BuyerGuaranteePrice>
      <BuyerRequirementDetails>
        <ShipToRegistrationCountry>true</ShipToRegistrationCountry>
      </BuyerRequirementDetails>
      <ReturnPolicy>
        <RefundOption>MoneyBackOrReplacement</RefundOption>
        <Refund>Money back or replacement (buyer's choice)</Refund>
        <ReturnsWithinOption>Days_60</ReturnsWithinOption>
        <ReturnsWithin>60 Days</ReturnsWithin>
        <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
        <ReturnsAccepted>Returns Accepted</ReturnsAccepted>
        <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
        <ShippingCostPaidBy>Buyer</ShippingCostPaidBy>
      </ReturnPolicy>
      <ConditionID>1000</ConditionID>
      <ConditionDisplayName>New</ConditionDisplayName>
      <PostCheckoutExperienceEnabled>false</PostCheckoutExperienceEnabled>
      <SellerProfiles>
        <SellerShippingProfile>
          <ShippingProfileID>1**********0</ShippingProfileID>
          <ShippingProfileName>C*********************************************0</ShippingProfileName>
        </SellerShippingProfile>
        <SellerReturnProfile>
          <ReturnProfileID>1**********0</ReturnProfileID>
          <ReturnProfileName>R******************************************r</ReturnProfileName>
        </SellerReturnProfile>
        <SellerPaymentProfile>
          <PaymentProfileID>1**********0</PaymentProfileID>
          <PaymentProfileName>P****l</PaymentProfileName>
        </SellerPaymentProfile>
      </SellerProfiles>
      <RelistParentID>1**********4</RelistParentID>
      <HideFromSearch>false</HideFromSearch>
      <eBayPlus>false</eBayPlus>
      <eBayPlusEligible>false</eBayPlusEligible>
      <IsSecureDescription>true</IsSecureDescription>
    </Item>
    <Item>
      <AutoPay>false</AutoPay>
      <BuyerProtection>ItemIneligible</BuyerProtection>
      <Country>US</Country>
      <Currency>USD</Currency>
      <HitCounter>NoHitCounter</HitCounter>
      <ItemID>1**********2</ItemID>
      <ListingDetails>
        <RelistedItemID>1**********9</RelistedItemID>
        <StartTime>2019-10-15T12:20:04.000Z</StartTime>
        <EndTime>2019-10-22T12:20:04.000Z</EndTime>
        <ViewItemURL>https://www.ebay.com/itm/Our-Lady-Lourdes-Plate-1-Bradford-Exchange-Certified-Authentic-Garrido-/1**********2</ViewItemURL>
        <HasUnansweredQuestions>false</HasUnansweredQuestions>
        <HasPublicMessages>false</HasPublicMessages>
        <ViewItemURLForNaturalSearch>https://www.ebay.com/itm/Our-Lady-Lourdes-Plate-1-Bradford-Exchange-Certified-Authentic-Garrido-/1**********2</ViewItemURLForNaturalSearch>
      </ListingDetails>
      <ListingDuration>Days_7</ListingDuration>
      <Location>T***y, California</Location>
      <PrimaryCategory>
        <CategoryID>11135</CategoryID>
        <CategoryName>Collectibles:Decorative Collectibles:Decorative Collectible Brands:Roman:Other Roman</CategoryName>
      </PrimaryCategory>
      <Quantity>1</Quantity>
      <ReviseStatus>
        <ItemRevised>false</ItemRevised>
      </ReviseStatus>
      <SellingStatus>
        <BidCount>0</BidCount>
        <BidIncrement currencyID="USD">0.5</BidIncrement>
        <ConvertedCurrentPrice currencyID="USD">10.1</ConvertedCurrentPrice>
        <CurrentPrice currencyID="USD">10.1</CurrentPrice>
        <MinimumToBid currencyID="USD">10.1</MinimumToBid>
        <QuantitySold>0</QuantitySold>
        <SecondChanceEligible>false</SecondChanceEligible>
        <ListingStatus>Completed</ListingStatus>
      </SellingStatus>
      <ShippingDetails>
        <ShippingDiscountProfileID>0</ShippingDiscountProfileID>
        <InternationalShippingDiscountProfileID>*</InternationalShippingDiscountProfileID>
      </ShippingDetails>
      <ShipToLocations>US</ShipToLocations>
      <Site>US</Site>
      <Storefront>
        <StoreCategoryID>1</StoreCategoryID>
        <StoreCategory2ID>0</StoreCategory2ID>
        <StoreURL>https://stores.ebay.com/a***s</StoreURL>
      </Storefront>
      <TimeLeft>PT0S</TimeLeft>
      <Title>Our Lady of Lourdes Plate #1 - Bradford Exchange Certified Authentic- Garrido</Title>
      <WatchCount>0</WatchCount>
      <BestOfferDetails>
        <BestOfferCount>0</BestOfferCount>
        <BestOfferEnabled>true</BestOfferEnabled>
        <NewBestOffer>false</NewBestOffer>
      </BestOfferDetails>
      <LocationDefaulted>true</LocationDefaulted>
      <BuyerResponsibleForShipping>false</BuyerResponsibleForShipping>
      <PostalCode>9***1</PostalCode>
      <PictureDetails>
        <GalleryURL>https://i*********.com/*********/$**7.JPG?set_id=8*******0F</GalleryURL>
        <PhotoDisplay>PicturePack</PhotoDisplay>
        <PictureURL>https://i*********.com/*********/***0.jpg</PictureURL>
        <PictureURL>https://i*********.com/*********/***1.jpg</PictureURL>
        <PictureURL>https://i*********.com/*********/***2.jpg</PictureURL>
        <PictureURL>https://i*********.com/*********/***3.jpg</PictureURL>
        <PictureURL>https://i*********.com/*********/***4.jpg</PictureURL>
        <PictureURL>https://i*********.com/*********/***5.jpg</PictureURL>
      </PictureDetails>
      <ProxyItem>false</ProxyItem>
      <BuyerGuaranteePrice currencyID="USD">20000.0</BuyerGuaranteePrice>
      <BuyerRequirementDetails>
        <ShipToRegistrationCountry>true</ShipToRegistrationCountry>
      </BuyerRequirementDetails>
      <ReturnPolicy>
        <RefundOption>MoneyBackOrReplacement</RefundOption>
        <Refund>Money back or replacement (buyer's choice)</Refund>
        <ReturnsWithinOption>Days_14</ReturnsWithinOption>
        <ReturnsWithin>14 Days</ReturnsWithin>
        <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
        <ReturnsAccepted>Returns Accepted</ReturnsAccepted>
        <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
        <ShippingCostPaidBy>Buyer</ShippingCostPaidBy>
      </ReturnPolicy>
      <ConditionID>1000</ConditionID>
      <ConditionDisplayName>New</ConditionDisplayName>
      <PostCheckoutExperienceEnabled>false</PostCheckoutExperienceEnabled>
      <SellerProfiles>
        <SellerShippingProfile>
          <ShippingProfileID>1**********0</ShippingProfileID>
          <ShippingProfileName>C*********************************************1</ShippingProfileName>
        </SellerShippingProfile>
        <SellerReturnProfile>
          <ReturnProfileID>1**********0</ReturnProfileID>
          <ReturnProfileName>R********************************************0</ReturnProfileName>
        </SellerReturnProfile>
        <SellerPaymentProfile>
          <PaymentProfileID>1**********0</PaymentProfileID>
          <PaymentProfileName>P****l</PaymentProfileName>
        </SellerPaymentProfile>
      </SellerProfiles>
      <RelistParentID>1**********6</RelistParentID>
      <HideFromSearch>false</HideFromSearch>
      <eBayPlus>false</eBayPlus>
      <eBayPlusEligible>false</eBayPlusEligible>
      <IsSecureDescription>true</IsSecureDescription>
    </Item>
  </ItemArray>
  <ItemsPerPage>2</ItemsPerPage>
  <PageNumber>1</PageNumber>
  <ReturnedItemCountActual>2</ReturnedItemCountActual>
</GetSellerListResponse>



Change History

Change Date Description
1349
2024-02-26
  • CalculatedShippingRate (modified): The OriginatingPostalCode field has been decommissioned and removed from CalculatedShippingRateType. Use Item.PostalCode instead.
1323
2023-08-25
  • SiteCodeType (modified): Czechia and Cyprus have been added to SiteCodeType as enumeration values. These sites cannot be set in the X-EBAY-API-SITEID header, nor in the Site field of a request payload.
  • CalculatedShippingRate (modified): The OriginatingPostalCode field has been deprecated and is not usable. Currently ignored. Use Item.PostalCode instead.
1257
2022-05-06
  • Item.HitCount (modified): The logic of HitCount has been modified to show page views for the latest 30-day period, instead of tracking page views for the lifetime of the listing.
1247
2022-02-25
  • Item.HitCounter (deprecated): Hit counters are no longer shown in View Item pages, so this field is no longer applicable.
1193
2021-02-12
  • ShippingServiceCostOverride.ShippingSurcharge (deprecated): This element has been removed from the WSDL.
1161
2020-07-06
  • Item.ListingDesigner (deprecated): This container removed from WSDL, although it is possible that this container may still get returned in a response for an existing listing that was already using a Listing Designer template before this feature was retired.
1157
2020-06-05
  • Item.ListingDesigner (deprecated): Sellers are no longer able to use Listing Designer templates when they create or revise listings. Existing listings that are already using a Listing Designer template will remain unchanged.
  • Item.ReturnPolicy (doc change): Updated return policy-related documentation to make it more clear that if a seller does not add a separate international return policy for an item, the settings in the domestic return policy will be used instead.
1145
2020-03-13
  • Charity.CharityID, Charity.CharityNumber (doc change): Clarified the difference between CharityID (eBay identifier) and CharityNumber (PayPal Giving Fund identifier), and also added a note about CharityNumber field being scheduled for deprecation.
1119
2019-08-02
  • GalleryTypeCodeType (modified): The Featured value of GalleryTypeCodeType is no longer applicable with the scheduled deprecation of the Featured Gallery listing feature. Once the Featured Gallery listing feature is wired off, any existing listings with the GalleryType value set to Featured will default to a value of Gallery
  • ShippingServiceOptions.ShippingSurcharge (deprecated): The ShippingSurcharge field in ShippingServiceOptionsType has been removed from the Trading WSDL. For the next 18 months, this field will still be supported if used in a Add/Revise/Relist call, but it is recommended that sellers configure shipping surcharges in Shipping rate tables instead. Shipping rate tables can be added and modified through the Shipping Preferences in My eBay. Note that this field may still get returned in 'Get' calls if configured through Shipping rate tables.
1091
2019-01-18
  • ListingDetails.MinimumBestOfferPrice (modified): Sellers accepting Best Offers for an auction listing can now set the Best Offer Auto Reject threshold price to a dollar value higher than the auction starting price.
  • Item.MotorsGermanySearchable (deprecated): This field was deprecated since placing eBay Germany motor vehicle listings on the mobile.de site is no longer supported.
  • Seller.MotorsDealer (deprecated): This field was deprecated since eBay Motors Pro is a deprecated feature.
  • Item.ShippingTermsInDescription (deprecated): This field is no longer applicable, so was deprecated.
1085
2018-10-26
  • Item.PaymentMethods (modified): For sellers enrolled in the new eBay Managed Payments program, a specified payment method is not necessary. If a payment method is specified, such as PayPal, it will be dropped from the listing and the seller will get a warning message when the call is run.
  • Item.AutoPay (modified): The immediate payment feature is also available for sellers enrolled in the new eBay Managed Payments program. In the past, this feature was only available to sellers who were offering PayPal as the only available payment method.
  • ShippingDetails.SalesTax (doc change): Added a note to state that the Sales Tax rate for a US tax jurisdiction that is subject to the 'eBay Collect and Remit Tax' program will be ignored during the checkout process, since eBay will be collecting and remitting this tax to the tax authorities without the seller's involvement.
1081
2018-09-28
  • Item.ListingDuration (modified): A 30-day listing duration (Days_30) can now be set for eBay Motors listings. The 21-day listing duration (Days_21) will soon be wired off for eBay Motors listings.
  • RateTableDetails.DomesticRateTableId (modified): Regional shipping rate tables have been enabled for the following sites: Canada (English), Canada (French), and Italy. With regional shipping rate tables, the seller can customize and set the shipping rates based on shipping speed and distance to specified domestic regions. Regional shipping rate tables are required for sellers opted into the eBay Guaranteed Delivery feature and using the 'Door-to-Door' option.
1073
2018-08-03
  • ReturnPolicy.InternationalReturnsWithinOption, ReturnPolicy.ReturnsWithinOption (modified): The Months_1 enumeration value (a valid value for DE and AT sites) is being deprecated, and should no longer be used.
1061
2018-05-11
  • ReturnPolicy.InternationRefundOption (added): This release adds the option to specify return policies for international returns (which are items returned using an international shipping service). If you sell internationally, your international return policy is by default inherited from your domestic return policy (in this case ReturnPolicy.RefundOption). Set this option so st set up an international return policy if you want to differentiate your international return policy from your domestic return policy. For details, see the Release Notes.
  • ReturnPolicy.InternationReturnsAcceptedOption (added): This release adds the option to specify return policies for international returns.
  • ReturnPolicy.InternationReturnsWithinOption (added): This release adds the option to specify return policies for international returns.
  • ReturnPolicy.InternationShippingCostPaidByOption (added): This release adds the option to specify return policies for international returns.
  • ReturnPolicy.ExtendedHolidayReturns (deprecated): This release deprecates ExtendedHolidayReturns. Values passed to this field are ignored.
  • ReturnPolicy.RestockingFeeValueOption (deprecated): This release deprecates RestockingFeeValueOption. As of this release, sellers are no longer allowed to specify a special restocking fee for returned items. Values passed to this field are ignored.
  • ReturnPolicy.WarrantyDurationOption (deprecated): This release deprecates WarrantyDurationOption. As of this release, eBay no longer supports item warranties. Values passed to this field are ignored.
  • ReturnPolicy.WarrantyOfferedOption (deprecated): This release deprecates WarrantyOfferedOption. As of this release, eBay no longer supports item warranties. Values passed to this field are ignored.
  • ReturnPolicy.WarrantyTypeOption (deprecated): This release deprecates WarrantyTypeOption. As of this release, eBay no longer supports item warranties. Values passed to this field are ignored.
  • ReturnPolicy.Description (modified): This field is now valid for only the following marketplaces: EBAY_DE EBAY_ES EBAY_FR EBAY_IT. Values passed to this field in other marketplaces are ignored.
  • ReturnPolicy.RefundOption (modified): This field is now valid only on the US marketplace.
  • ReturnPolicy.ReturnsWithin (modified): The Days_14 option is being deprecated in many eBay categories. You might receive an error if you attempt to list an item with a 14-day return period. For details, see the Release Notes.
1039
2017-10-17
  • Item.IsSecureDescription (added): This boolean field indicates whether or not the listing description is HTTPS secure/compliant. To be HTTPS secure/compliant, the listing description field may not contain any links to site pages that use the HTTP (and not HTTPS) protocol.
  • ReturnPolicy.RestockingFeeValueOption (modified): The Percent_20 value indicates that the seller reserves the right to charge a restocking fee percentage for returned items of up to 20 percent (of sale price), but at the seller's discretion, they can also charge less than 20 percent.
  • ReturnPolicy.RestockingFeeValue (modified): The 20% value indicates that the seller reserves the right to charge a restocking fee percentage for returned items of up to 20 percent (of sale price), but at the seller's discretion, they can also charge less than 20 percent.
  • ShippingDetails.RateTableDetails (modified): Once a seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId fields, and the DomesticRateTable and InternationalRateTable tags will no longer work. The required IDs for these tables can be retrieved with the getRateTables method of the Account API.
1029
2017-08-18
  • ListingEnhancementsCodeType (modified): The following enumeration values are no longer applicable, as the listing enhancements associated with these enumeration values are no longer supported on any eBay Marketplace site: BasicUpgradePackBundle, Border, Featured, Highlight, ProPackBundle, and ProPackPlusBundle.
1027
2017-08-04
  • ListingTypeCodeType (modified): The Half enumeration value is being deprecated, as API support for Half.com listings is being deprecated.
  • UserStatusCodeType (modified): The CreditCardVerifyHalfOptIn and UnconfirmedHalfOptIn enumeration values are being deprecated, as API support for Half.com listings is being deprecated.
1019
2017-06-09
  • RateTableDetails.DomesticRateTableId (added): New field added to support new domestic shipping rate tables. The new shipping rate tables are currently only available on US and Australia sites, but will be coming soon to UK and Germany sites.
  • RateTableDetails.InternationalRateTableId (added): New field added to support new international shipping rate tables. The new shipping rate tables are currently only available on US and Australia sites, but will be coming soon to UK and Germany sites.
0997
2017-01-20
  • CalculatedShippingRate.PackageDepth (deprecated): This field is being deprecated. It will still be supported for 18 additional months, but for it to be available, the user will have to use Version 995 or older.
  • CalculatedShippingRate.PackageLength (deprecated): This field is being deprecated. It will still be supported for 18 additional months, but for it to be available, the user will have to use Version 995 or older.
  • CalculatedShippingRate.PackageWidth (deprecated): This field is being deprecated. It will still be supported for 18 additional months, but for it to be available, the user will have to use Version 995 or older.
  • CalculatedShippingRate.ShippingPackage (deprecated): This field is being deprecated. It will still be supported for 18 additional months, but for it to be available, the user will have to use Version 995 or older.
  • CalculatedShippingRate.WeightMajor (deprecated): This field is being deprecated. It will still be supported for 18 additional months, but for it to be available, the user will have to use Version 995 or older.
  • CalculatedShippingRate.WeightMinor (deprecated): This field is being deprecated. It will still be supported for 18 additional months, but for it to be available, the user will have to use Version 995 or older.
  • Item.ListingCheckoutRedirectPreference (deprecated): This field is being deprecated. Third-party checkout has been deprecated.
  • Item.PostCheckoutExperienceEnabled (deprecated): This field is being deprecated. The Post-Checkout Experience feature has been deprecated.
  • Item.SkypeContactOption (deprecated): This field is being deprecated. Member communication through Skype has been deprecated.
  • Item.SkypeEnabled (deprecated): This field is being deprecated. Member communication through Skype has been deprecated.
  • Item.SkypeID (deprecated): This field is being deprecated. Member communication through Skype has been deprecated.
  • Item.ThirdPartyCheckoutIntegration (deprecated): This field is being deprecated. Third-party checkout has been deprecated.
  • PictureDetails.GalleryURL (deprecated): This field is being deprecated from public WSDL. It is only used internally.
  • ReturnPolicy.EAN (deprecated): This field is being deprecated. The EAN value will no longer be a part of the seller's return policy. If specified for a product, the EAN value can be found in the ProductListingDetails or VariationProductListingDetails (for prouct variations) containers.
  • ShippingDetails.InsuranceFee (deprecated): This field is being deprecated.
  • ShippingDetails.InsuranceOption (deprecated): This field is being deprecated.
0955
2016-02-12
  • BuyerPaymentMethodCodeType (modified): The Moneybookers, ProPay, and Paymate enumeration values have been deprecated, and will no longer be returned in any calls.
0945
2015-10-15
  • BuyerPaymentMethodCodeType (modified): Moneybookers, ProPay, or Paymate will no longer be accepted as valid PaymentMethods for new listings. However, these payment methods will still be allowed for existing listings, so these values may still get returned until these payment methods are completely removed from all listings.
0933
2015-07-24
  • eBayPlusEligible (added): This new field returns a boolean value that indicates whether an item is is eligible to be listed under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Currently available only in Germany.
  • eBayPlus (added): This new field returns a boolean value that indicates whether the eBay Plus program is being offered on an item listing. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Currently available only in Germany.
0925
2015-05-29
  • NameValueList.Name (modified): In a multiple-variation listing, the Brand should be returned at the item level (ItemSpecifics container) and the MPN for the product variation should be returned at the variation level (VariationSpecifics container).
  • Item.ProductListingDetails (modified): In a multiple-variation listing, the product identifier (EAN, ISBN or UPC) for a product variation should be returned in the Variation.VariationProductListingDetails container instead.
  • BrandMPN.Brand (modified): Decreased maximum length of string value to 65 characters. If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand should be returned at the item level (this field and the ItemSpecifics container) and the MPN for each product variation should be returned at the variation level (VariationSpecifics container).
  • BrandMPN.MPN (modified): Decreased maximum length of string value to 65 characters. If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand should be returned at the item level (this field and the ItemSpecifics container) and the MPN for each product variation should be returned at the variation level (VariationSpecifics container).
  • ProductListingDetails.EAN (modified): In a multiple-variation listing, the EAN of a product variation should be returned in the VariationProductListingDetails container instead. If the listing is in a category that expects an EAN value, but one doesn't exist for the product, this field may contain text similar or identical to 'Does not apply'.
  • ProductListingDetails.ISBN (modified): In a multiple-variation listing, the ISBN of a product variation should be returned in the VariationProductListingDetails container instead. If the listing is in a category that expects an ISBN value, but one doesn't exist for the product, this field may contain text similar or identical to 'Does not apply'.
  • ProductListingDetails.UPC (modified): In a multiple-variation listing, the UPC of a product variation should be returned in the VariationProductListingDetails container instead. If the listing is in a category that expects a UPC value, but one doesn't exist for the product, this field may contain text similar or identical to 'Does not apply'.
  • VariationProductListingDetails (added): This container is returned if a product variation within a multiple-variation listing was identified with an EAN, an ISBN, or a UPC value.
0905
2015-01-09
  • CalculatedShippingRateType (modified): Data fields in this container used to specify shipping package weight and dimensions should no longer be used. Instead, the equivalents fields in ShippingPackageDetailsType should be used.
0899
2014-11-04
  • BuyerPaymentMethodCodeType (modified): 'QIWI' added as enumeration value. This payment method can only be specified on the US site and is only applicable to Russian buyers.
0897
2014-10-21
  • SiteCodeType (modified): 'Russia' added as enumeration value to support selling on the new Russia site.
0879
2014-06-17
  • PickupInStoreDetails.EligibleForPickupDropOff (added): This boolean field is returned as 'true' if the listing is enabled for the "Click and Collect" feature.
0861
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.
0859
2014-01-28
  • Item.OutOfStockControl (modified): OutOfStockControl can now be used with BestOffer.
0851
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).
0849
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.
0841
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.
0831
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.
0829
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.
0825
2013-05-22
  • ReturnPolicy.ReturnsWithinOption (modified): A new 'Months_1' value is now supported. This value indicates a one-month return policy.
0823
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.
0799
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).
0793
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.
0791
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.
0789
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.
0787
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.
0783
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.
0781
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.
0765
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.
0763
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.
0735
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.
0719
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.
0689
2010-09-20
  • ShippingType.ApplyShippingDiscount (deprecated): As of version 689, ApplyShippingDiscount is deprecated and removed from the schema.
0679
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.
0663
2010-03-31
  • ShippingType.ApplyShippingDiscount (deprecated): This tag is no longer being used. It will be officially deprecated later in 2010.
0635
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.
0629
2009-08-05
  • TopRatedSeller (added): Returned when seller is a Top-Rated Seller.
0619
2009-05-27
  • IncludeVariations, Variations (added): Use IncludeVariations to retrieve details about multi-variation listings.
0605
2009-02-18
  • NowAndNew (deprecated): Now & New (Sofort & Neu) has been retired as of this release.
0603
2009-02-04
  • Item.IntegratedMerchantCreditCardEnabled (added): Indicates that the IntegratedMerchantCreditCard payment method applies to the item.
0599
2009-1-07
  • NowAndNew (doc change): eBay will retire Now & New (Sofort & Neu) by March 2009.
0581
2008-09-03
  • ItemArray.Item.ReturnPolicy (added): Specifies the seller's return policy.
0573
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.
0567
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.
0563
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.
0561
2008-04-16
  • Item.ListingType.Express (deprecated): Due to the shutdown of UK and Germany eBay Express sites Item.ListingType.Express has been deprecated.
0559
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.
0557
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.
0555
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.
0553
2008-02-20
  • ProductListingDetails.StockPhotoURL (doc change): The documentation has been corrected to remove this container and element.
0551
2008-02-06
  • HitCount (added): The number of hits on an item.
0537
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.
0507
2007-04-04
  • PayPerLeadEnabled (added): Added for the pay-per-lead feature, applicable beginning in upcoming months on the US site.
0503
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.
0499
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.
0497
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.
0491
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.
0489
2006-11-29
  • ItemArray.Item.WatchCount (doc change): ItemArray.Item.WatchCount added to GetSellerList output fields.
0483
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.
0477
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.
0471
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.
0469
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.
0465
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.
0463
2006-5-31
  • Sample (doc change): A DetailLevel of ReturnAll should NOT be used with this call.
0459
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.
0455
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).
0453
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.
0439
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.
0427
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.
0425
2005-9-7
  • IncludeWatchCount (added): Input argument that returns the WatchList element in Item objects.
0419
2005-7-27
  • GranularityLevel (added): Filter to control the amount of data returned per record (similar to DetailLevel).
0415
2005-5-29
  • Item.GetItFast (added): This field supports the new Get It Fast feature.
0411
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.