eBay Shopping APIVersion 1085

SimpleItemType

Complex type that is used to express the details of an eBay listing.

Types that use SimpleItemType:

Calls that use SimpleItemType:

Fields

DistanceFromBuyer ( DistanceType )
HalfItemCondition ( HalfItemConditionCodeType )
SKU ( string )


AutoPay ( boolean ) [0..1]
This field indicates if the seller requests immediate payment for the item. If true, immediate payment is required before the checkout process can begin. If false, immediate payment is not requested.

The immediate payment feature is only applicable to fixed-price listings, or for auction listings where the buyer chooses to purchase the item through the 'Buy It Now' option. The immediate payment feature is not applicable (even if the AutoPay field has a true value) in the following types of listings/transactions:
  • Classified ad listings where payment/checkout happens between buyer and seller off of eBay's platform
  • Auction listings that end with a winning bidder
  • A buyer's Best Offer (on Fixed-Price or Auction items) that is accepted by the seller
The immediate payment feature is only applicable to listings on PayPal-enabled sites in categories that support immediate payment, or if the seller is opted into the new eBay Managed Payments program. For the former, the only returned PaymentMethods value should be PayPal. For sellers, opted into the new eBay Managed Payments program, the supported payment methods are managed by eBay, so no payment methods may get returned.
See the Field Index to learn which calls use AutoPay.

AvailableForPickupDropOff ( boolean ) [0..1]
If this field is returned as true, the order line item is enabled with the 'Click and Collect' feature. With Click and Collect, buyers are able to purchase an order line item on the eBay UK, Australia, and Germany sites, and then pick up their order from the nearest 'eBay Collection Point', including over 750 Argos stores in the UK.

The Click and Collect feature is only available on the eBay UK, Australia, and Germany sites. For more information about Click and Collect, see the Click and Collect home page on the eBay UK site, the Click and Collect home page on the eBay Australia site, or the Click and Collect home page on the eBay Germany site.

Not all categories on the UK, Australia, and Germany sites support Click and Collect listings. To verify if a specific category on these eBay sites support Click and Collect listings, use the GetCategoryFeatures call, passing in one or more CategoryID values and a PickupDropOffEnabled value in the FeatureID field.

Look for a true value in the PickupDropOffEnabled field of the corresponding Category node (match up the CategoryID values if more than one Category IDs were passed in the request).
See the Field Index to learn which calls use AvailableForPickupDropOff.

BestOfferEnabled ( boolean ) [0..1]
This boolean field indicates whether the seller will accept a Best Offer for the item. The Best Offer feature allows a buyer to propose a price that is lower than the fixed price or lower than the current bid price on an auction listing. A buyer should consider their Best Offer as a binding offer, and if the seller accepts the offer, that buyer is expected to purchase the item (and is actually charged immediately if the listing is set up for immediate payment.

Note: For auction listings, either the Best Offer feature or the Buy It Now feature can be enabled on the listing, but not both features. Once a qualifying bid is made on an auction listing, both the Best Offer feature or the Buy It Now feature cease being an option to interested buyers.
See the Field Index to learn which calls use BestOfferEnabled.

BidCount ( int ) [0..1]
This integer value indicates the number of bids that have been placed on an auction item. This field is only applicable to auction listings, but it is always returned for all listings, and its value will be '0' if bids are not applicable to the listing.
See the Field Index to learn which calls use BidCount.

BusinessSellerDetails ( BusinessSellerDetailsType ) [0..1]
This container is returned if the seller of the item is registered on the eBay listing site as a Business Seller. This container consists of information related to the Business Seller's account. Not all eBay sites support Business Sellers.
See the Field Index to learn which calls use BusinessSellerDetails.

BuyItNowAvailable ( boolean ) [0..1]
This field is only returned if the Buy It Now feature is enabled and available on an active auction listing. This field is only returned if true. With the Buy It Now feature, interested buyers have the option of bypassing the auction procedure, and purchasing the item immediately at the price shown in the BuyItNowPrice field (or in the ConvertedBuyItNowPrice field for international buyers.

Once a qualifying bid is made on an auction listing, the Buy It Now feature ceases being an option to interested buyers, and the BuyItNowAvailable field will no longer be returned for the active auction listing.
See the Field Index to learn which calls use BuyItNowAvailable.

BuyItNowPrice ( AmountType (double) ) [0..1]
This field is only returned if a seller enabled an auction listing with the Buy It Now feature. Sellers have the option of enabling the Buy It Now feature on auction listings. The price in this field is the price that an interested buyer has to pay if that buyer wishes to bypass the auction procedure, and purchase the item immediately. The price in the field reflects the currency used in the eBay site's country. If an interested international buyer wants to view the Buy It Now price in their country's currency, that buyer should view the ConvertedBuyItNowPrice field instead.

Once a qualifying bid is made on an auction listing, the Buy It Now feature ceases being an option to interested buyers. Note that it is possible that the BuyItNowPrice field may still get returned even after the Buy It Now feature is disabled, but the BuyItNowAvailable field should stop getting returned, since that field is only returned when true.

To see the fixed price for a fixed-price or classified ad listing, or the starting/current bid price for an auction listing, see the CurrentPrice or ConvertedCurrentPrice fields instead.
See the Field Index to learn which calls use BuyItNowPrice.

Charity ( CharityType ) [0..1]
This container is returned if any percentage of the sales proceeds is going to a nonprofit organization registered with the PayPal Giving Fund. This container consists of details related to the nonprofit charity organization, including the name and identifier of the charity, as well as the percentage rate of the sale proceeds that will go to the charity for each sale.

This container is not returned for non-charitable listings.
See the Field Index to learn which calls use Charity.

ConditionDescription ( string ) [0..1]
This string field is used by the seller to more clearly describe the condition of items that are not brand new.

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

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

The ConditionDescription field is only returned if a condition description is specified in the listing.
See the Field Index to learn which calls use ConditionDescription.

ConditionDisplayName ( string ) [0..1]
The user-friendly display name for the item condition, such as New, Like New Used, Good, or Manufacturer refurbished. Display names are localized for the site on which they're listed (not necessarily the site on which they're viewed).

ConditionDisplayName values all map to ConditionID values, but keep in mind that based on the eBay category, some item conditions can have the same ConditionID, but a slightly different ConditionDisplayName. For example, a ConditionID value of 1000 typically indicates an item in new condtion, but the text displayed in the ConditionDisplayName can be just New, or some categories will show Brand New, New with tags, or New with box.

This field will get returned for most listings since most eBay listing categories require an item condition, but this field may not get returned for listings in eBay categories that don't require an item condition. A ConditionDisplayName value always maps to a text-based description of the condition, and this Condition ID is shown in the ConditionID field.
See the Field Index to learn which calls use ConditionDisplayName.

ConditionID ( int ) [0..1]
A numeric identifier that represents the condition of an item. These numeric IDs can vary by eBay category, but many are the same across categories. For example, 1000 indicates an item in New condition, 3000 indicates an item in Used condition, and 5000 indicates an item in Good condition.

This field will get returned for most listings since most eBay listing categories require an item condition, but this field may not get returned for listings in eBay categories that don't require an item condition. A ConditionID value always maps to a text-based description of the condition, and this display text is shown in the ConditionDisplayName field.
See the Field Index to learn which calls use ConditionID.

ConvertedBuyItNowPrice ( AmountType (double) ) [0..1]
This field is only returned if a seller enabled an auction listing with the Buy It Now feature. Sellers have the option of enabling the Buy It Now feature on auction listings. The price in this field is the price that an interested buyer has to pay if that buyer wishes to bypass the auction procedure, and purchase the item immediately. The price in the field reflects the currency used in the buyer's country. This value and the BuyItNowPrice will be the same for domestic buyers (for example, a US buyer purchasing an item on the US site).

Once a qualifying bid is made on an auction listing, the Buy It Now feature ceases being an option to interested buyers. Note that it is possible that the ConvertedBuyItNowPrice field may still get returned even after the Buy It Now feature is disabled, but the BuyItNowAvailable field should stop getting returned, since that field is only returned when true.

To see the fixed price for a fixed-price or classified ad listing, or the starting/current bid price for an auction listing, see the ConvertedCurrentPrice or CurrentPrice fields instead.
See the Field Index to learn which calls use ConvertedBuyItNowPrice.

ConvertedCurrentPrice ( AmountType (double) ) [0..1]
In a fixed-price or classified ad listing, this price is the current price of the item, shown in the currency of the user's country. In an active auction listing, this field's value reflects the current bid price for the auction item, so any submitted bids must be above this value. If the Buy It Now feature is available for an auction item (look for BuyItNowAvailable field), the user will want to look at the ConvertedBuyItNowPrice field instead if that user is interested in skipping the auction process and buying that item immediately.

Note: If the user retrieves a multiple-variation listing, and the IncludeSelector filter is set to Variations, the ConvertedCurrentPrice field is still returned, but its value will reflect the lowest-priced item variation. So, if the multiple-variation listing has item variations priced from 7.99 to 12.99, the ConvertedCurrentPrice field's value will show '7.99'. If the price of all item variations are the same, the ConvertedCurrentPrice field value will be accurate, but it is recommended that the user scan down to individual Variation.StartPrice fields to get the accurate price for all item variations.
See the Field Index to learn which calls use ConvertedCurrentPrice.

Country ( CountryCodeType ) [0..1]
A two-letter code that represents the country in which the item is located.

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

Most of the codes that eBay uses conform to the ISO 3166 standard, but some of the codes in the ISO 3166 standard are not used by eBay. Plus, there are some non-ISO codes in the eBay list.

Note: The CountryCodeType list is only a subset of all supported country codes, so to ensure that you are seeing the latest list, you should make a GeteBayDetails call as explained above.
See the Field Index to learn which calls use Country.

CurrentPrice ( AmountType (double) ) [0..1]
In a fixed-price or classified ad listing, this price is the current price of the item, shown in the currency of the listing site's country. In an active auction listing, this field's value reflects the current bid price for the auction item, so any submitted bids must be above this value. If the Buy It Now feature is available for an auction item (look for BuyItNowAvailable field), the user will want to look at the ConvertedBuyItNowPrice (or ConvertedBuyItNowPrice) field instead if that user is interested in skipping the auction process and buying that item immediately.

This field is only returned if the IncludeSelector field is included and set to Details. Alternatively, the user can view the ConvertedCurrentPrice field, as this field shows the price in the currency of the user's country, and it is always returned.

Note: If the user retrieves a multiple-variation listing, and the IncludeSelector filter is set to Variations, the CurrentPrice is not returned, but the ConvertedCurrentPrice field is returned, but its value will reflect the lowest-priced item variation. So, if the multiple-variation listing has item variations priced from 7.99 to 12.99, the ConvertedCurrentPrice field's value will show '7.99'. If the price of all item variations are the same, the ConvertedCurrentPrice field value will be accurate, but it is recommended that the user scan down to individual Variation.StartPrice fields to get the accurate price for all item variations.
See the Field Index to learn which calls use CurrentPrice.

Description ( string ) [0..1]
The seller's description of the listing. This field is only returned if the IncludeSelector field is included in the call request, and its value is set to either TextDescription or Description. If the Description value is used, the full description is returned, with all HTML, XML, or CSS markup used in the listing (if any) by the seller. To only view the actual text of the listing description (no markup tags), the TextDescription value shall be used instead.

For product-based listings that are using the Product Description defined in the associated eBay catalog product, this field will either not be returned, or it will be returned as an empty element.
See the Field Index to learn which calls use Description.

DiscountPriceInfo ( DiscountPriceInfoType ) [0..1]
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, and Spain 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 listings.
See the Field Index to learn which calls use DiscountPriceInfo.

DistanceFromBuyer ( DistanceType ) [0..1]
Not used by any call.

The distance of the item from the buyer. The DistanceFromBuyer unit (miles or kilometers) varies by site. If the country whose site you are searching, e.g. India, uses kilometers, then the DistanceFromBuyer unit is kilometers. Otherwise, e.g. if the country is US or UK, then the DistanceFromBuyer unit is miles. DistanceFromBuyer is returned if a value for PostalCode is supplied in the request.
See the Field Index to learn which calls use DistanceFromBuyer.

eBayNowAvailable ( boolean ) [0..1]
Not used by any call.

The eBay Now delivery option is no longer available, so this field is no longer applicable.
See the Field Index to learn which calls use eBayNowAvailable.

eBayNowEligible ( boolean ) [0..1]
Not used by any call.

The eBay Now delivery option is no longer available, so this field is no longer applicable.
See the Field Index to learn which calls use eBayNowEligible.

EligibleForPickupDropOff ( boolean ) [0..1]
This boolean field is returned as true if the listing category supports 'Click and Collect' listings. A true value does not necessarily mean that the seller has enabled the item with the Click and Collect feature. A listing is enabled with the Click and Collect feature if the AvailableForPickupDropOff field is returned as true.

With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK, Australia, and Germany sites, and then pick up their order from the nearest 'eBay Collection Point', including over 750 Argos stores in the UK. The Click and Collect feature is only available on the eBay UK, Australia, and Germany sites. For more information about Click and Collect, see the Click and Collect home page on the eBay UK site, the Click and Collect home page on the eBay Australia site, or the Click and Collect home page on the eBay Germany site.
See the Field Index to learn which calls use EligibleForPickupDropOff.

EndTime ( dateTime ) [0..1]
For active listings, this timestamp indicates the date and time when the listing is scheduled to end, and for recently ended listings, this timestamp indicates the date and time when the listing actually ended.
See the Field Index to learn which calls use EndTime.

ExcludeShipToLocation ( string ) [0..*]
An ExcludeShipToLocation field is returned for each geographical region, country, state/province, city, or other special domestic location that the seller has added to their 'Excluded shipping locations' list. Sellers can exclude shipping locations through the Shipping preferences in My eBay, through a Shipping Business Policy that is associated with the listing, or through an Add/Revise/Relist call in the Trading API. Buyers in excluded shipping locations will be blocked from buying the item. If a seller has not created an 'Exclusion list' through any of the three means discussion below, no ExcludeShipToLocation fields are returned.

Geographical regions include the continents, as well as other geographical regions like the 'Middle East' or 'Southeast Asia'. Individual countries are represented by the two-digit ISO 3166-1 values. Special domestic regions will vary by country, but for the US, these value include 'Alaska/Hawaii', 'US Protectorates', and 'PO Boxes'.

This field works in conjunction with Item.ShipToLocations to create a set of international countries and regions to where the seler will, and will not, ship. These values should not contradict one another.
See the Field Index to learn which calls use ExcludeShipToLocation.

GalleryURL ( anyURI ) [0..1]
This field shows the URL to the thumbnail-size image of the listing's Gallery picture. The 'Gallery Picture' is the picture that displays by default when a user first visits a listing's View Item page.

eBay listing images must be one of the following image formats: JPEG, BMP, TIF, or GIF.

This field is generally always returned as long as the seller is using eBay's picture server (also known as EPS) to host the listing's images.
See the Field Index to learn which calls use GalleryURL.

GermanMotorsSearchable ( boolean ) [0..1]
Not used by any call.

This field is returned (as true) if an eBay Germany motor vehicle listing has an upgrade that allows the motor vehicle listing to appear on the mobile.de partner site. This field is only applicable to eBay Germany motor vehicle listings.
See the Field Index to learn which calls use GermanMotorsSearchable.

GetItFast ( boolean ) [0..1]
Not used by any call.

The Get It Fast feature and icon are no longer supported in eBay listings.
See the Field Index to learn which calls use GetItFast.

Gift ( boolean ) [0..1]
Not used by any call.

Note: This field is deprecated, as the gift icon and gift services are no longer available on any eBay Marketplace site.
See the Field Index to learn which calls use Gift.

GlobalShipping ( boolean ) [0..1]
This boolean field is returned as true if eBay's Global Shipping Program is an option for international shipping. With eBay's Global Shipping Program, the seller ships the item to that country's eBay shipping partner, and then eBay's shipping partner handles all aspects of the international leg of the shipment, including any export or import charges.

In addition to making the Global Shipping Program available for international shipment, the seller can also specify up to four other international shipping service options. This may be necessay if the shipment is going to a country where the Global Shipping Program is not available.

If the value of GlobalShipping is false, the seller is responsible for specifying one or more international shipping service options to serve those countries that the seller is willing to ship items.
See the Field Index to learn which calls use GlobalShipping.

HalfItemCondition ( HalfItemConditionCodeType ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use HalfItemCondition.

HandlingTime ( int ) [0..1]
Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. Typically, the seller's stated handling time ranges from zero to three business days. This time does not include the expected transit time of the shipping service option selected by the buyer.

GetSingleItem or GetMultipleItems returns HandlingTime in most cases, but there may be instances where the seller has not specified any shipping service options, or the the type of listing or eBay category does not require a handling time. For example, handling time is not relevant for 'local pickup' only, for freight shipping, or for classified ad listings where the transaction and delivery/shipping happens off of eBay's platform.

A HandlingTime value of 0 indicates same business day handling for an item. In this case, the seller's shipping commitment depends on the order cut off time set in the seller's My eBay Shipping preferences. The buyer must purchase and pay for the order line item before this order cut off time in order for the seller to be obligated to ship out the order on that same business day. A different cutoff time can be specified for each business day of the week. By default, the order cut off time is set to 2:00 PM local time on most sites, but the seller can change the times for any of the business days. For orders completed after the order cut off time, the item must be shipped by the end of the following business day (weekends and local holidays excluded).
See the Field Index to learn which calls use HandlingTime.

HighBidder ( SimpleUserType ) [0..1]
This container provides a few details about the current high bidder for an active auction listing, or the winning bidder for a completed auction listing. This container is only returned for auction listings with at least one bid, and only if the IncludeSelector filter is included in the request and set to Details. The high bidder details include the bidder's eBay user ID and Feedback Score. For the GetItemStatus call, only the eBay user ID is returned.

Note: The eBay user ID and the Feedback data will actually be obfuscated to all users except for the owner (seller) of the listing, so essentially, the HighBidder container only has value to the seller of the listing.
See the Field Index to learn which calls use HighBidder.

HitCount ( long ) [0..1]
The number of times the listing's View Item page has been viewed (as determined by eBay). Only returned if the seller has chosen to include a hit counter in the listing, and if the seller has also chosen to make the listing's hit count publicly visible. This field is retrieved asynchronously. If you believe the item has a publicly visible hit count, but this field is not returned, retry the call.
See the Field Index to learn which calls use HitCount.

IgnoreQuantity ( boolean ) [0..1]
This field is only be returned (as true) in the case where an order line item in a listing is only available to buyers through a local fulfillment method such as In-Store Pickup or Click and Collect. And if a listing is truly a local fulfillment only listing, the value in the Item.Quantity field (for single-variation listings) or the Variation.Quantity field (for multi-variation listings) defaults to 0 even though the quantity available is technically not zero, since the order line item in the listing is still available through one or more local fulfillment methods.
See the Field Index to learn which calls use IgnoreQuantity.

IntegratedMerchantCreditCardEnabled ( boolean ) [0..1]
This boolean field indicates whether or not the seller's account is enabled with a payment gateway account, that allows that seller to accept common credit cards as payment methods. If the value of IntegratedMerchantCreditCardEnabled is true, then the seller accepts common credit cards as payment methods.
See the Field Index to learn which calls use IntegratedMerchantCreditCardEnabled.

ItemCompatibilityCount ( int ) [0..1]
This integer value indicates the number of distinct motor vehicles that are compatible with the part or accessory being offered in the listing. The compatible vehicle list is shown in the ItemCompatibilityList container.

This field only applies to motor vehicle parts and accessory listings with an associated vehicle compatibility list. Seller can manually create their own vehicle compatibility list when listing the item, or a vehicle compatibility list may be added to the listing automatically if the seller uses an eBay catalog product record to create the listing.

To retrieve the compatibility count and the compatible vehicle list, include the IncludeSelector field in the request with a value of Compatibility. Parts Compatibility is only supported in Parts & Accessories categories.
See the Field Index to learn which calls use ItemCompatibilityCount.

ItemCompatibilityList ( ItemCompatibilityListType ) [0..1]
A list of distinct motor vehicles that are compatible with the part or accessory being offered in the listing. Compatible vehicles are expressed through a set of name-value pairs with aspects such as 'Year, 'Make', 'Model', 'Trim', and 'Engine'. Each set of values describe the specific vehicle, such as a '2016 Honda Accord'.

This field only applies to motor vehicle parts and accessory listings with an associated vehicle compatibility list. Seller can manually create their own vehicle compatibility list when listing the item, or a vehicle compatibility list may be added to the listing automatically if the seller uses an eBay catalog product record to create the listing.

To retrieve the compatibility count and the compatible vehicle list, include the IncludeSelector field in the request with a value of Compatibility. Parts Compatibility is only supported in Parts & Accessories categories.
See the Field Index to learn which calls use ItemCompatibilityList.

ItemID ( string ) [0..1]
The unique identifier of the eBay listing. This will be the same ItemID value that is passed into the call request.
See the Field Index to learn which calls use ItemID.

ItemSpecifics ( NameValueListArrayType ) [0..1]
This container is a list of Item Specific name-value pairs used by the seller to provide desciptive details of an item in a structured manner. Depending on the eBay category, some Item Specifics are mandatory (including some GTIN values), some are recommended by eBay, and some are fully optional to the seller. A full set of helpful, accurate Item Specifics are always helpful to prospective buyers in assisting them to find and purchase the right product.

A book's Item Specifics name-value pairs might include Publication Year=2017 and Format=Hardcover. A motor vehicle's Item Specifics name-value pairs might include Make= Toyota, Model=Prius, and Year=2017. An event listing's Item Specifics name-value pairs might include Event Type=Concert and Venue Name=The Fillmore.

In order for Item Specifics to be returned, the IncludeSelector must be included in the call request and set to ItemSpecifics. Most eBay listings will include at least a few Item Specifics.
See the Field Index to learn which calls use ItemSpecifics.

ListingStatus ( ListingStatusCodeType ) [0..1]
This enumeration value indicates the current status of the listing. The three different listing states are discussed below.
See the Field Index to learn which calls use ListingStatus.

ListingType ( ListingTypeCodeType ) [0..1]
The enumeration value in this field indicates the format of the listing, such as auction, fixed-price, or classified ad format. See the ListingTypeCodeType definition to view the supported enumeration values.
See the Field Index to learn which calls use ListingType.

Location ( string ) [0..1]
The text string in this field provides the physical location of the item. Generally, this text will show the city and state/province of the item's location, but it may vary, and sometimes only a city will appear, or sometimes acronymns will be used, and other times the full city and state will be spelled out. This gives the buyer a general indication of where the item will be shipped from, and if calculated shipping is used, shipping charges may be higher the further away that the buyer resides from the shipping location.
See the Field Index to learn which calls use Location.

LotSize ( int ) [0..1]
A lot is a collection or set of two or more similar or identical items that must be purchased together in a single transaction, through an auction or a fixed-price listing. Examples of lot-based listings may include a collection of baby clothes, a collection of books or magazines, or a set of identical items such as batteries or light bulbs. The LotSize is the number of items in the lot.

A fixed-price listing can have multiple lots available for purchase, but if this is the case, each lot available in that listing should be identical (instead of a mixed collection of items). So, if a fixed-price listing has multiple lots available for purchase, the number of lots available for purchase is shown in the Item.Quantity field.

Not all eBay listing categories support lot-based listings. To see which eBay listing categories do not support lot-based listing, a user can use the Trading API's GetCategories call and then look for any Category.LSD tags (with value of true) that are returned in the response.
See the Field Index to learn which calls use LotSize.

MinimumToBid ( AmountType (double) ) [0..1]
This field is only returned for auction listings. The value in this field is the minimum value that the next bid on the item must be to be accepted. If no bids have been placed on the item, the value in this field will be the same value that is returned in the Item.ConvertedCurrentPrice field.
See the Field Index to learn which calls use MinimumToBid.

NewBestOffer ( boolean ) [0..1]
Not used by any call.

This field is no longer applicable, as it formerly supported the Best Offer Beta feature which is no longer active.
See the Field Index to learn which calls use NewBestOffer.

PaymentAllowedSite ( SiteCodeType ) [0..*]
Enables you to view the sites on which an item can be purchased, based on the payment methods offered for the item.
See the Field Index to learn which calls use PaymentAllowedSite.

PaymentMethods ( BuyerPaymentMethodCodeType ) [0..*]
Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item.

Note: At this time, if the seller is opted in to the new eBay Managed Payments program, the available payment methods (which are controlled by eBay and not the seller) may not be returned, but those payment methods will be exposed on the listing's View Item page. For classified ad listings, the available payment methods may appear in the response, but be aware that the exchange of money for a purchase happens off of eBay's platform.
See the Field Index to learn which calls use PaymentMethods.

PictureExists ( boolean ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use PictureExists.

PictureURL ( anyURI ) [0..*]
This field shows the URL to a full-size version of one image associated with the eBay listing. A PictureURL field is returned for each image in the eBay listing. At least one PictureURL field is always returned since every eBay listing must have at least one picture.

Many eBay categories support up to 12 pictures, and motor vehicle categories support up to 24 pictures.
See the Field Index to learn which calls use PictureURL.

PostalCode ( string ) [0..1]
This string value is the postal code (or zip code) of the item's physical location. Knowing the location gives the buyer a general indication of where the item will be shipped from, and if calculated shipping is used, shipping charges may be higher the further away that the buyer resides from the shipping location.
See the Field Index to learn which calls use PostalCode.

PrimaryCategoryID ( string ) [0..1]
The unique identifier of the eBay listing's primay category. This field is always returned. Some listings are shown in an additional secondary category, and if this is the case, the unique identifier of the secondary category is shown in the SecondaryCategoryID field.
See the Field Index to learn which calls use PrimaryCategoryID.

PrimaryCategoryIDPath ( string ) [0..1]
This field shows the full path to the primary listing category, starting with the Category ID of the Level 1 (L1) category, and all the way to primary listing category (also referred to as the leaf category). So, if the primary listing category is a Level 4 (L4) category, the Category ID path in this field might look like the following, where '6000' is the L1 category ID, and '6444' is the primary listing category ID:

6000:6001:6016:6444
See the Field Index to learn which calls use PrimaryCategoryIDPath.

PrimaryCategoryName ( string ) [0..1]
This string field shows the full category path (using category names) to the primary listing category, starting with the L1 category and ending with the name of the primary listing category. This is a fully qualified category breadcrumb (e.g., Cell Phones & Accessories:Cell Phones & Smartphones).
See the Field Index to learn which calls use PrimaryCategoryName.

ProductID ( ProductIDType (string) ) [0..1]
This field is no longer returned in the GetSingleItem or GetMultipleItems calls. To view the eBay Product ID (also known as an ePID) or Global Trade Item Number (UPC, EAN, ISBN, or MPN) for a product in a listing (or product variation within a multiple-variation listing), use the Trading API's GetItem call instead.
See the Field Index to learn which calls use ProductID.

Quantity ( int ) [0..1]
The quantity of the item available for purchase when the seller created, revised, or relisted the item. An auction listing always has a Quantity value of 1, but a fixed-price listing can have multiple quantity of an item.

In a multiple-quantity, fixed-price listing, the user must also look at the QuantitySold field, and if the value of this field is an integer value greater than '0', that integer value should be subtracted from the value in the Quantity field. So, if the Quantity field shows a value of '7', and the QuantitySold field shows a value of '3', the quantity available is actually '4' (7 - 3 = 4).

Note: The Quantity field is always returned except in the case of a multiple-variation listing, and the user sets the IncludeSelector filter to Variations. In this particular case, the (listing-level) Quantity field is not returned, and instead, the user will look at the Variation.Quantity and Variation.SellingStatus.QuantitySold fields to get the quantity available for each item variation in the listing. If the user retrieves a multiple-variation listing, but does not set the IncludeSelector filter to Variations, the listing-level Quantity and QuantitySold fields are returned, and these fields' values will be the cumulative values of all item variations in the listing.
Note: As mentioned earlier, an auction listing can only have a quantity of '1', but a lot-based auction listing can have multiple identical/similar items sold as one unit for one price. For example, instead of listing 10 light bulbs for US 2.00 each, they might list 10 light bulbs for USD 20.00 (where you have to buy all 10). For lot-based listings (which are also supported by the fixed-price format), the number of identical/similar items in the 'lot' is shown in the LotSize field. The seller is also expected to summarize all items in the lot in the Description field.
See the Field Index to learn which calls use Quantity.

QuantityAvailableHint ( QuantityAvailableHintCodeType ) [0..1]
The enumeration returned in this field indicates if the listing displays a 'quantity available' hint on the View Item page. For example, the View Item page may say 'Limited quantity available', or it may say 'More than 10 available'. It is up to the seller of the listing whether or not to included a 'quantity available' hint in the listing. The 'quantity available' feature is used by the seller that prefers not to show the actual quantity available for purchase.

This field is only applicable to multiple-quantity, fixed-price listings, and will only be returned if the seller set this feature on the listing.
See the Field Index to learn which calls use QuantityAvailableHint.

QuantityInfo ( QuantityInfo ) [0..1]
This container consists of the MinimumRemnantSet field, which indicates the minimum amount of event tickets that can remain in the fixed-price listing's inventory after a buyer purchases one or more tickets (but not all) from the listing.

This field is currently only applicable for event ticket listings in US and CA, but may apply to other categories in the future. It is only returned if set by the seller in the listing.
See the Field Index to learn which calls use QuantityInfo.

QuantitySold ( int ) [0..1]
This integer value indicates the quantity of items sold for the listing. If the IncludeSelector filter is included in the request and set to Details, this field is always returned even if its value is '0'.

If the QuantitySold value is greater than '0', this value should be subtracted from the value in the Quantity field to get the accurate quantity that is available for purchase.

Note: If the IncludeSelector filter is included in the request and set to Details, but the retrieved listing is a multiple-variation listing, the Quantity and QuantitySold field values will reflect the quantity and quantity sold of all item variations in the listing. If a user wanted quantity available and quantity sold information on individual item variations, that user would set the IncludeSelector filter to Variations instead, and the user will look at the Variation.Quantity and Variation.SellingStatus.QuantitySold fields to get the quantity available for each item variation in the listing.
See the Field Index to learn which calls use QuantitySold.

QuantitySoldByPickupInStore ( int ) [0..1]
This integer value indicates the quantity of items sold for the listing through the In-Store Pickup option. If the IncludeSelector filter is included in the request and set to Details, this field is always returned even if its value is '0'.

If the QuantitySoldByPickupInStore value is greater than '0', this value (along with the value in QuantitySold) should be subtracted from the value in the Quantity field to get the accurate quantity that is available for purchase.

Note: If the IncludeSelector filter is included in the request and set to Details, but the retrieved listing is a multiple-variation listing, the Quantity, the QuantitySoldByPickupInStore, and QuantitySold field values will reflect the quantity and quantity sold of all item variations in the listing. If a user wanted quantity available and quantity sold information on individual item variations, that user would set the IncludeSelector filter to Variations instead, and the user will look at the Variation.SellingStatus.QuantitySoldByPickupInStore fields to get the quantity sold for each item variation in the listing through the In-Store Pickup option.
Note: The In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.
See the Field Index to learn which calls use QuantitySoldByPickupInStore.

QuantityThreshold ( int ) [0..1]
This field works together with the 'quantity available' feature. This integer value in this field controls whether the 'quantity available' hint on the View Item page will say 'Limited quantity available' or 'More than N available'. If this threshold value is '10', and the quantity available is any number more than 10, the 'quantity available' hint will read 'More than 10 available'. If the quantity available is '10' or less, the 'quantity available' hint will read 'Limited quantity available'.
See the Field Index to learn which calls use QuantityThreshold.

RecentListing ( boolean ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use RecentListing.

ReserveMet ( boolean ) [0..1]
This boolean field indicates if the current/highest bid price has matched or exceeded the price set as the Reserve Price by the seller. A Reserve Price is the lowest price at which the seller is willing to sell the item through an auction. If the highest bid does not meet or exceed the Reserve Price, the auction listing will end without a sale (winning bidder) when the scheduled end time is reached.

The Reserve Price must be higher than the starting bid price, but lower than the Buy It Now price (if one is set). This field is only applicable to auction listings, and only returned for auction listings if the seller has set a Reserve Price.
See the Field Index to learn which calls use ReserveMet.

ReturnPolicy ( ReturnPolicyType ) [0..1]
This container consists of details related to the seller's Return Policy, both for domestic and international buyers (if the seller ships internationally). If the seller does not accept returns, only the ReturnsAccepted field (or InternationalReturnsAccepted field for international buyers) is returned with a value of ReturnsNotAccepted. If a seller does accept returns, more details are returned, including the return period, the refund method, and the order partner (buyer or seller) who is responsible for return shipping costs. This container is only returned if the IncludeSelector field is included in the call request and set to Details.
See the Field Index to learn which calls use ReturnPolicy.

SecondaryCategoryID ( string ) [0..1]
The unique identifier of the eBay listing's secondary category. This field is only returned if the listing is surfacing in a secondary category. The listing's primary category is found in the PrimaryCategoryID field.
See the Field Index to learn which calls use SecondaryCategoryID.

SecondaryCategoryIDPath ( string ) [0..1]
This field shows the full path to the secondary listing category, starting with the Category ID of the Level 1 (L1) category, and all the way to secondary listing category. This field is only returned if the listing is surfacing in a secondary category.
See the Field Index to learn which calls use SecondaryCategoryIDPath.

SecondaryCategoryName ( string ) [0..1]
This string field shows the full category path (using category names) to the secondary listing category, starting with the L1 category and ending with the name of the secondary listing category. This field is only returned if the listing is surfacing in a secondary category.
See the Field Index to learn which calls use SecondaryCategoryName.

Seller ( SimpleUserType ) [0..1]
This container provides a few details about the listing's seller, including the seller's eBay user ID, Feedback Score, and Positive Feedback Percentage. This container is only returned if IncludeSelector is included in the request and set to Details.
See the Field Index to learn which calls use Seller.

SellerComments ( string ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use SellerComments.

ShippingCostSummary ( ShippingCostSummaryType ) [0..1]
This container returns a few details of the lowest-priced shipping service option that is available to the eBay user making the call. For Calculated shipping, the item's location and the destination location are considered when calculating the shipping cost.

Important: To retrieve detailed information on every shipping service option available that the seller has set for the listing, the GetShippingCosts call is the better call to use, as the GetSingleItem and GetMultipleItems calls only return the ShippingCostSummary container.
See the Field Index to learn which calls use ShippingCostSummary.

ShipToLocations ( string ) [0..*]
A ShipToLocations field is returned for each domestic or international region that the seller is willing to ship the item. At least one ShipToLocations field should be returned for every listing. 'Ship-to' locations and excluded shipping locations are set by the seller through Shipping Rate Tables in My eBay, through a Shipping/Fulfillment Business Policy associated with a listing, or through the ShipToLocations and ExcludeShipToLocation fields in an Add/Revise/Relist call in the Trading API.

'Ship-to' locations range from continents and other large geographical regions, such as Africa, Asia, Caribbean, or MiddleEast, all the way down to the state/province level and even cities within those state/provinces. A user will be able to see the international and domestic shipping regions that can be set by looking at the Shipping rate tables UI in My eBay. The Trading API's GeteBayDetails can also be used to view available shipping locations.

If a US seller only ships to domestic locations, the only ShipToLocations value that should be returned is US. If a US seller is willing to ship to any location in the world, the only ShipToLocations value that should be returned is Worldwide

Countries are represented by the two-digit codes defined in the ISO 3166 standard, or these codes can also be found in the CountryCodeType definition.
See the Field Index to learn which calls use ShipToLocations.

Site ( SiteCodeType ) [0..1]
This enumeration value indicates the eBay marketplace on which the item was originally listed. For example, if the item is listed on the eBay US site, the value would be US. If it's listed on the eBay Germany site, the value would be Germany.
See the Field Index to learn which calls use Site.

SKU ( string ) [0..1]
A SKU (stock keeping unit) value is a seller-defined identifier of a product within their inventory. Some sellers use product SKUs to track complex flows of products and information on the client side. A seller can specify a SKU value for a product (or for all variations within a multiple-variation listing) when creating a listing. eBay preserves the SKU values, and the SKU value becomes another way to identify the product/listing, and another way to track orders associated with the SKU value.

A SKU is not required to be unique across an eBay marketplace, but a seller cannot have any active listings or variations within a multiple-variation listing that have the same SKU value. The seller will be blocked from listing, revising, or relisting with a SKU value that is already associated with an active listing.

The SKU field, if defined for a single-variation listing, will be returned if the IncludeSelector field is set to Details. For multi-variation listings, the SKU value for each variation (if defined) will actually be returned in the Variation.SKU field, and to return variations data, the user must include the IncludeSelector field and set it to Variations.
See the Field Index to learn which calls use SKU.

StartTime ( dateTime ) [0..1]
This timestamp indicates the date and time when the listing started.
See the Field Index to learn which calls use StartTime.

Storefront ( StorefrontType ) [0..1]
This container consists of the eBay seller's store name and the URL to the eBay store. This container is returned if the seller has an eBay Store subscription and the IncludeSelector field is included in the call request and set to Details.
See the Field Index to learn which calls use Storefront.

Subtitle ( string ) [0..1]
The subtitle of the listing. This field is only returned if the seller included a subtitle for the listing and the IncludeSelector is included in the call request and set to Details.
See the Field Index to learn which calls use Subtitle.

TimeLeft ( duration ) [0..1]
The value in this field indicates the precise time left before the listing is scheduled to end. The format used in this field is the format defined in the ISO 8601 duration format standard. See the duration simple type definition for more information on syntax/notation used for this type.

This field is always returned, even if the listing is in the Completed state. A completed/ended listing will essentially have 0 seconds left, so the Completed value will be PT0S, which indicates '0 seconds' left.
See the Field Index to learn which calls use TimeLeft.

Title ( string ) [0..1]
The listing title, as it appears in search results or on the View Item page.
See the Field Index to learn which calls use Title.

TopRatedListing ( boolean ) [0..1]
This boolean field is returned as true if the listing was created by a Top-Rated Seller and the listing has all of the requirements that qualifies it as a Top-Rated Plus listing. The Top-Rated Seller program is only available on the US, UK, and Germany sites. See the Top-Rated Seller requirements help topic for more information on qualifying as a Top-Rated Seller and the Top-Rated Plus listing requirements help topic for more information on what a listing must offer to qualify as a Top-Rated Plus listing and get the Top-Rated Plus badge. Information on the overall program can be found on the Top-Rated Seller home page in the Seller Center.

This field is not returned if false.
See the Field Index to learn which calls use TopRatedListing.

UnitInfo ( UnitInfoType ) [0..1]
Contains information about the weight, volume or other quantity measurement of a listed item so buyers can compare per-unit prices. The European Union requires listings for certain types of products to include the price per unit. eBay uses this information and the item's listed price to calculate and display the unit price on eBay EU sites.

Note: This information is currently required only for business sellers, and only for listings with a 'Buy It Now' option.
See the Field Index to learn which calls use UnitInfo.

Variations ( VariationsType ) [0..1]
This container is only returned for multiple-variation listings, and it is required that the user include the IncludeSelector field in the call request, and set its value to Variations. Multiple-variation listings are fixed-price listings that feature similar, but not identicial items. For example, a T-shirt listing could contain multiple items of the same brand and style that vary by color and size (like Blue, Large and Black, Medium). Each variation in the listing specifies a unique combination of one of the available colors and sizes. Each variation can have a different quantity and price.
See the Field Index to learn which calls use Variations.

VhrAvailable ( boolean ) [0..1]
This field is returned as true if a Vehicle History Report is available for a motor vehicle listing. This field is only applicable to motor vehicle listings with a Vehicle History Report avaialable. The URL to the Vehicle History Report can be found in the VhrUrl field.
See the Field Index to learn which calls use VhrAvailable.

VhrUrl ( anyURI ) [0..1]
This field is returned with the URL to the Vehicle History Report if the seller has made one available for a motor vehicle listing. This field is only applicable to motor vehicle listings with a Vehicle History Report avaialable.
See the Field Index to learn which calls use VhrUrl.

ViewItemURLForNaturalSearch ( anyURI ) [0..1]
This field shows the URL to the listing's View Item page on the eBay marketplace.
See the Field Index to learn which calls use ViewItemURLForNaturalSearch.

WatchCount ( int ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use WatchCount.