Inherits from NSObject
Conforms to PicoBindable
Declared in Shopping_SimpleItemType.h
Shopping_SimpleItemType.m

Overview

Contains information for an item.

@ingroup ShoppingInterface

Tasks

  •   bestOfferEnabled

    Whether the seller will accept a best offer for this item.
    This feature enables a buyer to make a lower-priced binding offer on a
    fixed price item. Buyers can’t see how many offers have been made
    (only the seller can see this information). To make a best offer on a
    listing, use the eBay Web site.

    property
  •   buyItNowPrice

    The Buy It Now price of the item, returned in the currency of the site
    on which the item was listed.




    For Chinese auctions (competitive bidding online auctions),
    Buy It Now lets a user purchase the item at a fixed price and
    end the auction immediately. On most sites, after a Chinese
    auction has bids, the listing is no longer eligible for Buy It Now.
    However, calls can return BuyItNowPrice if
    the seller originally listed the item with a Buy It Now option.
    Use the Item.BidCount field to determine whether an auction with
    Buy It Now has bids or not, and use Item.BuyItNowAvailable to see
    if the Buy It Now option is still available.




    Price fields are returned as doubles, not necessarily in the traditional
    monetary format of the site’s country. For example, a US Dollar value might be
    returned as 3.880001 instead of 3.88.




    For fixed-price (FixedPriceItem) listings, see CurrentPrice or ConvertedCurrentPrice instead.




    Returned only if an item was listed with a Buy It Now option.

    property
  •   description

    The seller’s description of the item, if any. This can include
    HTML markup and JavaScript. See <a
    href=“types/simpleTypes.html#string”>string
    in Simple Schema Types.




    Some sellers don’t specify their own listing description.
    Instead, they use a stock description from a catalog available
    through eBay. (GetSingleItem doesn’t return this stock information.)

    property
  •   itemID

    The ID that uniquely identifies the item listing. eBay generates this ID
    when an item is listed. This ID is unique across all eBay sites.

    property
  •   buyItNowAvailable

    Indicates whether the item has an active Buy It Now option. On most sites, the
    Buy It Now option is disabled once a valid bid for the item has been accepted.
    To see if the item was listed with a Buy It Now option, see if the response
    includes Item.BuyItNowPrice.




    This field is returned only if the value is true.

    property
  •   convertedBuyItNowPrice

    The listing’s Buy It Now Price (if any), converted into the currency
    of the site to which you sent this request.




    Price fields are returned as doubles, not necessarily in the traditional
    monetary format of the site’s country. For example, a US Dollar value might be
    returned as 3.880001 instead of 3.88.




    Some eBay sites also support multi-item Buy It Now auctions, where you can buy
    multiple items from the same listing at a fixed price. See Item.BuyItNowAvailable.




    For fixed-price (FixedPriceItem) listings, see
    CurrentPrice or ConvertedCurrentPrice instead.




    Returned only if an item was listed with a Buy It Now option.




    For active items, refresh this value every 24 hours to pick up the current
    conversion rates (if this value has been converted).

    property
  •   endTime

    Time stamp (in GMT)
    of when the listing is scheduled to end, or time stamp of the actual end time
    (if the item ended).

    property
  •   startTime

    Time stamp (in GMT) that
    eBay recorded as the moment that the listing was made available.
    The start time returned by a search call may vary
    from the value returned by GetSingleItem.

    property
  •   viewItemURLForNaturalSearch

    The URL to view this listing on eBay. 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. For example, this URL specifies the item title, and
    it is optimized for natural search: “_W0QQ” is like “?” (question mark), “QQ” is like
    “&” (ampersand), and “Z” is like “=” (equals sign). You shouldn’t modify the
    query syntax in your application. For example, eBay won’t recognize the URL if you
    change QQ to ?.

    property
  •   listingType

    The format of the listing, such as online auction, fixed price,
    or advertisement format.

    property
  •   location

    Physical location of the item, as specified by the seller.
    (This gives a general indication of where the item will be
    shipped or delivered from.)

    property
  •   paymentMethods

    Identifies the payment method (such as PayPal) the seller
    will accept when the buyer pays for the item.



    Note:
    If the seller only accepts PayPal, the buyer can still pay
    with a credit card. PayPal supports major credit cards.



    Payment methods are not applicable to eBay Real Estate advertisement
    listings, or other Classified Ad format listings.

    property
  •   galleryURL

    URL for a picture used as the Gallery thumbnail, if any. The image uses
    one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only
    returned if the seller chose to show a gallery image.

    property
  •   pictureURL

    Contains the URL for an image associated with the item, if any.
    Returned only if the seller included at least one picture
    in their listing. Note that this element does not return the URLs of
    pictures that the seller included in the Description via HTML IMG tags.




    Items listed the main eBay site can have a maximum of 12 picture URLs
    hosted by eBay Picture Services, or a maximum of 6 picture URLs hosted by a
    third party (such as the a photo site). Note that a listing can have up to
    24 picture URLs on the US eBay Motors site (for all vehicle listings),
    and on the eBay Canada Motors site.




    eBay uses the seller’s first picture at the top of the listing's
    View Item page.

    property
  •   postalCode

    Postal code indicating the physical location of the item,
    as specified by the seller. (This gives a general indication of where
    the item will be shipped or delivered from.)

    property
  •   primaryCategoryID

    Numeric ID of the first (or only) category in which the item is listed.
    (Listings can appear in more than one category.)

    property
  •   primaryCategoryName

    Display name of the first (or only) category in which the item is
    listed. This is a fully qualified category breadcrumb
    (e.g., Computers & Networking:Laptops, Notebooks).

    property
  •   quantity

    The number of items the seller is offering in the listing. (Subtract
    Item.QuantitySold from this value to calculate the number of items
    currently available for sale.)




    An online, comptetitive-bidding auction with a Quantity of 1 is referred to as a <
    i>Chinese auction. Basic fixed-price and Store Inventory listings can
    have a Quantity of 1 or more.




    The listing’s current or Buy It Now price is the price of the item in the
    listing.




    Note:
    A seller can also offer multiple items for sale with a single
    price for all the items. For example, instead of listing 10 lightbulbs
    for US 2.00 each, they might list 10 lightbulbs for USD 20.00 (where
    you have to buy all 10). This is called a “lot."




    If the listing includes a lot, Quantity does not specify the lot size; it
    reflects how many lots are being sold. For example, if the original listing
    included 5 lots of 10 lightbulbs each, Quantity would be 5.


    property
  •   seller

    Container for information about this listing’s seller.

    property
  •   bidCount

    The number of bids that have been placed on the item.




    On most sites, the Buy It Now Option becomes unavailable once an auction
    has a valid bid. Note that the bid must be above any reserve price.




    FindPopularItems: For fixed-price listings, the BidCount
    value is the total number of items purchased so far (in the listing's
    lifetime).

    property
  •   convertedCurrentPrice

    The listing’s Buy It Now Price (if any), converted into the currency
    of the site to which you sent this request.




    Price fields are returned as doubles, not necessarily in the traditional
    monetary format of the site’s country. For example, a US Dollar value might be
    returned as 3.880001 instead of 3.88.




    Some eBay sites also support multi-item Buy It Now auctions, where you can buy
    multiple items from the same listing at a fixed price. See Item.BuyItNowAvailable.




    For fixed-price (FixedPriceItem) listings, see
    CurrentPrice or ConvertedCurrentPrice instead.




    Returned only if an item was listed with a Buy It Now option.




    For active items, refresh this value every 24 hours to pick up the current
    conversion rates (if this value has been converted).

    property
  •   currentPrice

    The current price of the item in the currency of the site on which the item was
    listed. That is, CurrentPrice is in the original listing currency.




    For competitive-bidding auction listings, this is the current minimum bid price (if
    the listing has no bids) or the current high bid (if the listing has bids). This
    does not reflect the BuyItNow price.




    For Basic Fixed-Price (FixedPriceItem) and Ad format (AdType) listings, this is the
    current fixed price.

    property
  •   highBidder

    The high bidder for comptetitive-bidding auctions that have ended and have a winning
    bidder. This indicates the user who purchased the item.




    Not returned for auctions that have received no bids, or for fixed price and
    Store Inventory listings that are still active.

    property
  •   listingStatus

    Specifies a listing’s status in eBay’s processing workflow.
    If an item’s EndTime is in the past, but no details about the
    buyer or high bidder are shown (and the user is not anonymous),
    use this listing status information to determine whether eBay has
    finished processing the listing.

    property
  •   quantitySold

    Number of items purchased so far from this listing. (Subtract this value from
    Item.Quantity to calculate the number of items currently available for sale.)

    property
  •   reserveMet

    Indicates whether any bids on this item are greater than the seller's
    reserve price for the listing (if any).




    A reserve is the lowest price at which the seller is willing to sell
    the item. The reserve price is higher than the listing’s opening bid
    (minimum bid) and lower than the Buy It Now price, if any.
    (The reserve price is only known to the seller.)
    Some sellers don’t set a reserve at all. If a listing does have
    a reserve price, the highest bidder will only win
    the item if their bid is also above that price.




    Only returned for online auctions that have a reserve price. (Fixed price, Store
    Inventory, and classified ad listings don’t have reserve prices.)

    property
  •   shipToLocations

    An international location or region to which the seller is willing
    to ship this item. Returned only for items that have ShipToLocations
    specified.




    Applicable values:

    •   Americas

    (North, South, or Latin America)

    •   Asia

    •   Caribbean

    •   Europe

    •   EuropeanUnion

    •   LatinAmerica

    •   MiddleEast

    •   NorthAmerica

    •   Oceania

    (Pacific region other than Asia)

    •   SouthAmerica

    •   WillNotShip

    (No shipping, buyer must pick up the item)

    •   Worldwide

    (Seller will ship worldwide)

    •   2-letter [country](#//api/name/country) identifier

    (See CountryCodeType for values)

    property
  •   site

    The name of the eBay site 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.




    The listing’s original site can affect the values of converted
    (localized) prices (when your request specifies a site
    that is different from the listing’s site).

    property
  •   timeLeft

    Time left before the listing ends.
    The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS).
    For ended listings, the time left is PT0S (zero seconds).

    property
  •   title

    Name of the item as it appears in the listing or in search and
    browse results.




    For US eBay Motors vehicles only: In item-retrieval
    calls (like GetSingleItem and GetMultipleItems), this value shows the
    vehicle Make and Model (e.g., “Buick : Skylark”).




    Note:
    GetSingleItem does not return the same Item.Title
    value for US eBay Motors listings. Here’s why:




    In general, GetSingleItem maps to eBay’s View Item page. The eBay Motors
    Web site’s View Item page shows two vehicle titles in the title bar: One
    title is a label based on the Year, Make, Model, and Submodel (e.g.,
    “1996 Buick Skylark Limited”). The model is included unless it’s “Other"
    or unspecified. The submodel is included if the seller specified a
    submodel. The other title is a path based on the Make and Model (e.g.,
    "Buick : Skylark”). The Item.Title value in GetSingleItem maps to this
    path.


    property
  •   shippingCostSummary

    Contains basic shipping-related costs for the item. If Item.Quantity
    is greater than 1, this is the shipping cost for one item.
    If the seller offers a choice of more than one shipping service
    (such as UPS Ground and USPS Media mail), this is the cost of the
    “first” shipping option (usually the lowest cost option).




    If a listing has shipping costs, use GetShippingCosts if you want to get
    more details about the services and costs that the seller is offering.

    property
  •   itemSpecifics

    Category-specific fields that the seller added to describe
    the listing. The names of these fields are different for items
    in different categories, so they’re returned in a generic
    Name/Value structure. The field names are usually very well known
    within the category.




    For example, a book’s item specifics might include a field like
    Publication Year=2007 (where Publication Year is returned in Name, and
    2007 is returned in Value), and a field like Format=Hardcover. But a car's
    item specifics would be different from a book’s, with fields like Make=
    Toyota and Model=Prius. And a ticket’s item specifics would be different
    from those of books and cars, with fields like EventType=Concerts and
    Venue=The Fillmore.




    One of the most common uses for item specifics is the item condition.




    Only returned if the seller included Item Specifics in the listing.



    Note:
    Starting in May 2010, many categories in Production and Sandbox
    will start returning the item condition in ConditionID and
    ConditionDisplayName instead, if the seller used ConditionID
    instead of ItemSpecifics.
    Monitor the eBay Developers Program
    newsletter for details and timing.

    property
  •   hitCount

    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.




    Not applicable to Half.com

    property
  •   subtitle

    Subtitle of the item. Only returned if the seller included a
    subtitle for the listing.




    For US eBay Motors passenger vehicle, motorcycle, and “other vehicle"
    categories or listings in CA eBay Motors passenger vehicle and
    motorcycle categories, the seller’s subtitle is only available
    in the Item.ItemSpecifics node. Call GetSingleItem with
    IncludeSelector=ItemSpecifics to retrieve a listing’s Item Specifics.

    property
  •   primaryCategoryIDPath

    The fully qualified ID breadcrumb (path) of the first category.
    For example, if the primary category ID is 45678, and its parent
    category’s ID is 123, the breadcrumb (path) would be 123:45678.

    property
  •   secondaryCategoryID

    ID of the second category in which the item is listed. Returned only if
    the seller listed a second category.

    property
  •   secondaryCategoryName

    Name of the second category in which the item is listed. Returned only if
    the seller listed a second category.

    property
  •   secondaryCategoryIDPath

    The fully qualified ID breadcrumb (path) of the second category. For example, if the
    secondary category ID is 45678, and its parent category’s ID is 123, the breadcrumb
    (path) would be 123:45678. Returned only if the seller listed a second category.

    property
  •   charity

    Identifier for a Giving Works listing and the benefiting nonprofit charity
    organization.

    property
  •   germanMotorsSearchable

    The item is featured in eBay search results on the mobile.de partner site.
    Applicable to eBay Germany.

    property
  •   getItFast

    A Get It Fast listing.

    property
  •   gift

    If true, a generic gift icon displays next the listing’s title in search and
    browse pages.

    property
  •   pictureExists

    Returns true if the item has an associated picture. Not returned
    if value is false.

    property
  •   recentListing

    Returns true if the item listing is no more than one day old. Not returned
    if value is false.

    property
  •   storefront

    Returns the seller’s store information if the seller has an eBay store.
    Returns a blank store if the seller does not have an eBay storefront.

    property
  •   distanceFromBuyer

    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.

    property
  •   country

    Two-letter ISO 3166 country code to indicate the country where the item is located.

    property
  •   watchCount

    Number of users who have placed the item on their Watch list.

    property
  •   halfItemCondition

    Returns the Half.com condition code for the item. For example, “brand new,"
    "used,” etc.

    property
  •   sellerComments

    Notes that the Seller made when they listed the item. Not returned if the Seller
    did not make any comments.

    property
  •   returnPolicy

    If a seller specified return policy details, then this container has fields with
    those details. The fields that can be returned in this container vary by site.

    property
  •   minimumToBid

    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
    competitive-bid auction listings. Returns null for basic Fixed Price
    (FixedPriceItem) and Ad type listings.

    property
  •   productID

    A prototype description of a well-known type of item, such as a popular book.




    When returned for GetSingleItem, is always of type Reference, and serves as a global
    reference ID for an eBay catalog product.




    When used as input, retrieves product details for one specific product. Specify the
    ID as a string, and use the type attribute to indicate the nature of the ID you are
    specifying.




    The request requires either QueryKeywords or
    ProductID, but these fields cannot be used together.

    property
  •   autoPay

    If true, the seller requires immediate payment for the item. If false (or
    not specified), immediate payment is not requested. Buyers must have a
    PayPal account to purchase items that require immediate payment.



    A seller can choose to require immediate payment for Fixed Price and Buy
    It Now listings, including eBay Stores Inventory listings. If a Buy It
    Now item ends as an auction (that is, if the Buy It Now option is removed
    due to bids being placed on the listing), the immediate payment
    requirement does not apply.



    Note:
    The value of the AutoPay flag indicates the seller’s stated preference
    only. It does not indicate whether the listing is still a candidate for
    purchase via immediate payment. For example, if a listing receives bids
    and no longer qualifies for immediate payment, the value of the AutoPay
    flag does not change.



    Only applicable to items listed on PayPal-enabled sites and in categories
    that support immediate payment. Not applicable to Half.com.

    property
  •   businessSellerDetails

    Returns the seller’s business information. Set the SellerBusinessCodeType
    to ‘Commercial’ in the request to return the related information. This is only
    applicable for sites where Business Seller options are supported.

    property
  •   paymentAllowedSite

    Enables you to view the sites on which an item can be purchased,
    based on the payment methods offered for the item.

    property
  •   integratedMerchantCreditCardEnabled

    Indicates whether the item can be paid for through a payment gateway account. If
    IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card is
    enabled for credit cards because the seller has a payment gateway account. Therefore,
    if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is
    returned for an item, then on checkout, an online credit-card payment is processed
    through a payment gateway account.

    property
  •   variations

    Variations are multiple similar (but not identical) items in a single fixed-price (or
    Store Inventory Format) listing. For example, a single listing could contain multiple
    items of the same brand and model that vary by color and size (like “Blue, Large” and
    “Black, Medium”). Each variation can have its own quantity and price. Only returned
    if the listing contains multiple variations.

    property
  •   handlingTime

    Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. When listing the item the seller sets this to a positive integer value (1, 2, 3, 4, 5, 10, 15, or 20) corresponding to the number of days. This time does not include the shipping time (the carrier’s transit time). GetSingleItem or GetMultipleItems returns HandlingTime only when shipping service options are specified for the item and the seller specified a handling time.




    Valid for flat and calculated shipping. Does not apply when there is no shipping, or when using local pickup only or freight shipping.

    property
  •   lotSize

    A lot is a set of two or more similar items that must be purchased together in
    a single transaction. A listing can have multiple lots (instead of multiple
    items). When LotSize is specified, the listing price reflects the price of
    each lot (not each item within the lot). In this case, Quantity indicates the
    number of lots being listed, and LotSize indicates the number of items in each
    lot. (If a listing has no lots, Quantity indicates the number of separate
    items being listed.) Important: Lot items can be listed only in lot-enabled
    categories. GetCategories returns lot size disabled with a value of true
    for categories that do not support lots.



    Not applicable to Half.com.

    property
  •   conditionID

    Note:
    Starting in early March 2010, this will be supported for a
    few test categories in the Sandbox.
    In May 2010, ConditionID will be supported for many categories in
    Production and Sandbox. Monitor the eBay Developers Program
    newsletter for details and timing.





    The numeric ID (e.g., 1000) for the item condition.
    Only returned when the seller specified ConditionID in their listing. Also see ItemSpecifics in case the seller used that
    field for the condition instead.

    property
  •   conditionDisplayName

    Note:
    Starting in early March 2010, this will be supported for a
    few test categories in the Sandbox.
    In May 2010, ConditionDisplayName will be supported for
    many categories in Production and Sandbox.
    Monitor the eBay Developers Program
    newsletter for details and timing.





    The human-readable label for the item condition.
    Display names are localized for the site on
    which they’re listed (not necessarily the site on which
    they’re viewed).



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



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



    Only returned when ConditionID is returned. Also see ItemSpecifics
    in case the seller used that field for the condition instead.

    property
  •   quantityAvailableHint

    Indicates the type of message that will be returned describing the quantity
    available for the item.

    property
  •   quantityThreshold

    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.

    property
  •   discountPriceInfo

    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
    applies to only fixed price, BIN items. STP is available on the US, UK, and German
    (DE) 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
    “sepcial account flag” (SAF) that allows them to apply Discount Pricing to both MSKU
    and Non-MSKU items.

    property
  •   excludeShipToLocation

    Use this field to specify an international country or region, or a special domestic
    location (for sites supporting this feature, currently US, UK, DE) to where you
    will not ship the associated item. On input, repeat this element for each
    location that you want to exclude as a shipping destination for your item.



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



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



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



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



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



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



    Note:
    To enable your default Exclude Ship-To List, you must enable Exclude
    Shipping Locations and Buyer Requirements in your My eBay Site Preferences.
    For details, see the KnowledgeBase Article <a href=
    https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1495”

    HowTo: ExcludeShipToLocation.

    property
  •   topRatedListing

    This field is only applicable to the US site, and will only be returned if the US
    seller qualifies as a Top-Rated Seller. The current requirements for US sellers to
    qualify as Top-Rated Sellers are:

    • 100 or more selling transactions per year
    • Shipment tracking information provided to buyer within handling time for at least 90 percent of their listings




    If this flag is returned for a listing, it indicates that the listing meets the new
    requirements for a Top-Rated Listing. A Top-Rated Listing must meet the following
    requirements:

    • 14-day (or longer) return policy with Money Back option
    • 1-day Handling Time or better




    A new Top-Rated Plus seal will start appearing on the View Item
    page for all Top-Rated Listings beginning in November 2012. This seal will
    replace the Top-Rated Seller badge. US Top-Rated Sellers get a
    20 percent discount on their FVF for all listings that qualify as Top-Rated Listings.

    property
  •   vhrUrl

    The URL to the eBay Motors item’s full Vehicle History Report.
    Only returned when the item has a Vehicle History Report.

    property
  •   vhrAvailable

    If true, the eBay Motors item has a Vehicle History Report
    associated with it.

    property
  •   quantityInfo

    This container consists of the MinimumRemnantSet
    field, which sets 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.

    property
  •   unitInfo
    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.   
    <br/><br/>  
                   <span class="tablenote">  
                   <strong>Note:</strong> This information is currently required only for business sellers, and only for listings with a Buy It Now option.  
                   </span>  
    
    property
  •   globalShipping
    Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of <strong>GlobalShipping</strong> is <code>true</code>, 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 <strong>GlobalShipping</strong> is <code>false</code>, the seller is responsible for specifying an international shipping service for the listing if desired.  
    
    property
  •   any

    (public property)

    property
  •   conditionDescription

    This string field is used by the seller to more clearly describe the condition of
    items that are not brand new. This field becomes available to sellers starting in
    November 2012.



    The ConditionDescription field will be available for all
    categories, including categories where the condition type is not applicable
    (e.g., Antiques). This field will be 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.

    property

Properties

any

(public property)

@property (nonatomic, retain) NSMutableArray *any

Discussion

(public property)

entry type : PicoAnyElement, wrapper for primitive anyelement

Declared In

Shopping_SimpleItemType.h

autoPay

If true, the seller requires immediate payment for the item. If false (or
not specified), immediate payment is not requested. Buyers must have a
PayPal account to purchase items that require immediate payment.



A seller can choose to require immediate payment for Fixed Price and Buy
It Now listings, including eBay Stores Inventory listings. If a Buy It
Now item ends as an auction (that is, if the Buy It Now option is removed
due to bids being placed on the listing), the immediate payment
requirement does not apply.



Note:
The value of the AutoPay flag indicates the seller’s stated preference
only. It does not indicate whether the listing is still a candidate for
purchase via immediate payment. For example, if a listing receives bids
and no longer qualifies for immediate payment, the value of the AutoPay
flag does not change.



Only applicable to items listed on PayPal-enabled sites and in categories
that support immediate payment. Not applicable to Half.com.

@property (nonatomic, retain) NSNumber *autoPay

Discussion

If true, the seller requires immediate payment for the item. If false (or
not specified), immediate payment is not requested. Buyers must have a
PayPal account to purchase items that require immediate payment.



A seller can choose to require immediate payment for Fixed Price and Buy
It Now listings, including eBay Stores Inventory listings. If a Buy It
Now item ends as an auction (that is, if the Buy It Now option is removed
due to bids being placed on the listing), the immediate payment
requirement does not apply.



Note:
The value of the AutoPay flag indicates the seller’s stated preference
only. It does not indicate whether the listing is still a candidate for
purchase via immediate payment. For example, if a listing receives bids
and no longer qualifies for immediate payment, the value of the AutoPay
flag does not change.



Only applicable to items listed on PayPal-enabled sites and in categories
that support immediate payment. Not applicable to Half.com.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

bestOfferEnabled

Whether the seller will accept a best offer for this item.
This feature enables a buyer to make a lower-priced binding offer on a
fixed price item. Buyers can’t see how many offers have been made
(only the seller can see this information). To make a best offer on a
listing, use the eBay Web site.

@property (nonatomic, retain) NSNumber *bestOfferEnabled

Discussion

Whether the seller will accept a best offer for this item.
This feature enables a buyer to make a lower-priced binding offer on a
fixed price item. Buyers can’t see how many offers have been made
(only the seller can see this information). To make a best offer on a
listing, use the eBay Web site.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

bidCount

The number of bids that have been placed on the item.




On most sites, the Buy It Now Option becomes unavailable once an auction
has a valid bid. Note that the bid must be above any reserve price.




FindPopularItems: For fixed-price listings, the BidCount
value is the total number of items purchased so far (in the listing's
lifetime).

@property (nonatomic, retain) NSNumber *bidCount

Discussion

The number of bids that have been placed on the item.




On most sites, the Buy It Now Option becomes unavailable once an auction
has a valid bid. Note that the bid must be above any reserve price.




FindPopularItems: For fixed-price listings, the BidCount
value is the total number of items purchased so far (in the listing's
lifetime).

type : NSNumber, wrapper for primitive int

Declared In

Shopping_SimpleItemType.h

businessSellerDetails

Returns the seller’s business information. Set the SellerBusinessCodeType
to ‘Commercial’ in the request to return the related information. This is only
applicable for sites where Business Seller options are supported.

@property (nonatomic, retain) Shopping_BusinessSellerDetailsType *businessSellerDetails

Discussion

Returns the seller’s business information. Set the SellerBusinessCodeType
to ‘Commercial’ in the request to return the related information. This is only
applicable for sites where Business Seller options are supported.

type : class Shopping_BusinessSellerDetailsType

Declared In

Shopping_SimpleItemType.h

buyItNowAvailable

Indicates whether the item has an active Buy It Now option. On most sites, the
Buy It Now option is disabled once a valid bid for the item has been accepted.
To see if the item was listed with a Buy It Now option, see if the response
includes Item.BuyItNowPrice.




This field is returned only if the value is true.

@property (nonatomic, retain) NSNumber *buyItNowAvailable

Discussion

Indicates whether the item has an active Buy It Now option. On most sites, the
Buy It Now option is disabled once a valid bid for the item has been accepted.
To see if the item was listed with a Buy It Now option, see if the response
includes Item.BuyItNowPrice.




This field is returned only if the value is true.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

buyItNowPrice

The Buy It Now price of the item, returned in the currency of the site
on which the item was listed.




For Chinese auctions (competitive bidding online auctions),
Buy It Now lets a user purchase the item at a fixed price and
end the auction immediately. On most sites, after a Chinese
auction has bids, the listing is no longer eligible for Buy It Now.
However, calls can return BuyItNowPrice if
the seller originally listed the item with a Buy It Now option.
Use the Item.BidCount field to determine whether an auction with
Buy It Now has bids or not, and use Item.BuyItNowAvailable to see
if the Buy It Now option is still available.




Price fields are returned as doubles, not necessarily in the traditional
monetary format of the site’s country. For example, a US Dollar value might be
returned as 3.880001 instead of 3.88.




For fixed-price (FixedPriceItem) listings, see CurrentPrice or ConvertedCurrentPrice instead.




Returned only if an item was listed with a Buy It Now option.

@property (nonatomic, retain) Shopping_AmountType *buyItNowPrice

Discussion

The Buy It Now price of the item, returned in the currency of the site
on which the item was listed.




For Chinese auctions (competitive bidding online auctions),
Buy It Now lets a user purchase the item at a fixed price and
end the auction immediately. On most sites, after a Chinese
auction has bids, the listing is no longer eligible for Buy It Now.
However, calls can return BuyItNowPrice if
the seller originally listed the item with a Buy It Now option.
Use the Item.BidCount field to determine whether an auction with
Buy It Now has bids or not, and use Item.BuyItNowAvailable to see
if the Buy It Now option is still available.




Price fields are returned as doubles, not necessarily in the traditional
monetary format of the site’s country. For example, a US Dollar value might be
returned as 3.880001 instead of 3.88.




For fixed-price (FixedPriceItem) listings, see CurrentPrice or ConvertedCurrentPrice instead.




Returned only if an item was listed with a Buy It Now option.

type : class Shopping_AmountType

Declared In

Shopping_SimpleItemType.h

charity

Identifier for a Giving Works listing and the benefiting nonprofit charity
organization.

@property (nonatomic, retain) Shopping_CharityType *charity

Discussion

Identifier for a Giving Works listing and the benefiting nonprofit charity
organization.

type : class Shopping_CharityType

Declared In

Shopping_SimpleItemType.h

conditionDescription

This string field is used by the seller to more clearly describe the condition of
items that are not brand new. This field becomes available to sellers starting in
November 2012.



The ConditionDescription field will be available for all
categories, including categories where the condition type is not applicable
(e.g., Antiques). This field will be 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.

@property (nonatomic, retain) NSString *conditionDescription

Discussion

This string field is used by the seller to more clearly describe the condition of
items that are not brand new. This field becomes available to sellers starting in
November 2012.



The ConditionDescription field will be available for all
categories, including categories where the condition type is not applicable
(e.g., Antiques). This field will be 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.

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

conditionDisplayName

Note:
Starting in early March 2010, this will be supported for a
few test categories in the Sandbox.
In May 2010, ConditionDisplayName will be supported for
many categories in Production and Sandbox.
Monitor the eBay Developers Program
newsletter for details and timing.





The human-readable label for the item condition.
Display names are localized for the site on
which they’re listed (not necessarily the site on which
they’re viewed).



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



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



Only returned when ConditionID is returned. Also see ItemSpecifics
in case the seller used that field for the condition instead.

@property (nonatomic, retain) NSString *conditionDisplayName

Discussion

Note:
Starting in early March 2010, this will be supported for a
few test categories in the Sandbox.
In May 2010, ConditionDisplayName will be supported for
many categories in Production and Sandbox.
Monitor the eBay Developers Program
newsletter for details and timing.





The human-readable label for the item condition.
Display names are localized for the site on
which they’re listed (not necessarily the site on which
they’re viewed).



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



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



Only returned when ConditionID is returned. Also see ItemSpecifics
in case the seller used that field for the condition instead.

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

conditionID

Note:
Starting in early March 2010, this will be supported for a
few test categories in the Sandbox.
In May 2010, ConditionID will be supported for many categories in
Production and Sandbox. Monitor the eBay Developers Program
newsletter for details and timing.





The numeric ID (e.g., 1000) for the item condition.
Only returned when the seller specified ConditionID in their listing. Also see ItemSpecifics in case the seller used that
field for the condition instead.

@property (nonatomic, retain) NSNumber *conditionID

Discussion

Note:
Starting in early March 2010, this will be supported for a
few test categories in the Sandbox.
In May 2010, ConditionID will be supported for many categories in
Production and Sandbox. Monitor the eBay Developers Program
newsletter for details and timing.





The numeric ID (e.g., 1000) for the item condition.
Only returned when the seller specified ConditionID in their listing. Also see ItemSpecifics in case the seller used that
field for the condition instead.

type : NSNumber, wrapper for primitive int

Declared In

Shopping_SimpleItemType.h

convertedBuyItNowPrice

The listing’s Buy It Now Price (if any), converted into the currency
of the site to which you sent this request.




Price fields are returned as doubles, not necessarily in the traditional
monetary format of the site’s country. For example, a US Dollar value might be
returned as 3.880001 instead of 3.88.




Some eBay sites also support multi-item Buy It Now auctions, where you can buy
multiple items from the same listing at a fixed price. See Item.BuyItNowAvailable.




For fixed-price (FixedPriceItem) listings, see
CurrentPrice or ConvertedCurrentPrice instead.




Returned only if an item was listed with a Buy It Now option.




For active items, refresh this value every 24 hours to pick up the current
conversion rates (if this value has been converted).

@property (nonatomic, retain) Shopping_AmountType *convertedBuyItNowPrice

Discussion

The listing’s Buy It Now Price (if any), converted into the currency
of the site to which you sent this request.




Price fields are returned as doubles, not necessarily in the traditional
monetary format of the site’s country. For example, a US Dollar value might be
returned as 3.880001 instead of 3.88.




Some eBay sites also support multi-item Buy It Now auctions, where you can buy
multiple items from the same listing at a fixed price. See Item.BuyItNowAvailable.




For fixed-price (FixedPriceItem) listings, see
CurrentPrice or ConvertedCurrentPrice instead.




Returned only if an item was listed with a Buy It Now option.




For active items, refresh this value every 24 hours to pick up the current
conversion rates (if this value has been converted).

type : class Shopping_AmountType

Declared In

Shopping_SimpleItemType.h

convertedCurrentPrice

The listing’s Buy It Now Price (if any), converted into the currency
of the site to which you sent this request.




Price fields are returned as doubles, not necessarily in the traditional
monetary format of the site’s country. For example, a US Dollar value might be
returned as 3.880001 instead of 3.88.




Some eBay sites also support multi-item Buy It Now auctions, where you can buy
multiple items from the same listing at a fixed price. See Item.BuyItNowAvailable.




For fixed-price (FixedPriceItem) listings, see
CurrentPrice or ConvertedCurrentPrice instead.




Returned only if an item was listed with a Buy It Now option.




For active items, refresh this value every 24 hours to pick up the current
conversion rates (if this value has been converted).

@property (nonatomic, retain) Shopping_AmountType *convertedCurrentPrice

Discussion

The listing’s Buy It Now Price (if any), converted into the currency
of the site to which you sent this request.




Price fields are returned as doubles, not necessarily in the traditional
monetary format of the site’s country. For example, a US Dollar value might be
returned as 3.880001 instead of 3.88.




Some eBay sites also support multi-item Buy It Now auctions, where you can buy
multiple items from the same listing at a fixed price. See Item.BuyItNowAvailable.




For fixed-price (FixedPriceItem) listings, see
CurrentPrice or ConvertedCurrentPrice instead.




Returned only if an item was listed with a Buy It Now option.




For active items, refresh this value every 24 hours to pick up the current
conversion rates (if this value has been converted).

type : class Shopping_AmountType

Declared In

Shopping_SimpleItemType.h

country

Two-letter ISO 3166 country code to indicate the country where the item is located.

@property (nonatomic, retain) NSString *country

Discussion

Two-letter ISO 3166 country code to indicate the country where the item is located.

type: string constant in Shopping_CountryCodeType.h

Declared In

Shopping_SimpleItemType.h

currentPrice

The current price of the item in the currency of the site on which the item was
listed. That is, CurrentPrice is in the original listing currency.




For competitive-bidding auction listings, this is the current minimum bid price (if
the listing has no bids) or the current high bid (if the listing has bids). This
does not reflect the BuyItNow price.




For Basic Fixed-Price (FixedPriceItem) and Ad format (AdType) listings, this is the
current fixed price.

@property (nonatomic, retain) Shopping_AmountType *currentPrice

Discussion

The current price of the item in the currency of the site on which the item was
listed. That is, CurrentPrice is in the original listing currency.




For competitive-bidding auction listings, this is the current minimum bid price (if
the listing has no bids) or the current high bid (if the listing has bids). This
does not reflect the BuyItNow price.




For Basic Fixed-Price (FixedPriceItem) and Ad format (AdType) listings, this is the
current fixed price.

type : class Shopping_AmountType

Declared In

Shopping_SimpleItemType.h

description

The seller’s description of the item, if any. This can include
HTML markup and JavaScript. See <a
href=“types/simpleTypes.html#string”>string
in Simple Schema Types.




Some sellers don’t specify their own listing description.
Instead, they use a stock description from a catalog available
through eBay. (GetSingleItem doesn’t return this stock information.)

@property (nonatomic, retain) NSString *description

Discussion

The seller’s description of the item, if any. This can include
HTML markup and JavaScript. See <a
href=“types/simpleTypes.html#string”>string
in Simple Schema Types.




Some sellers don’t specify their own listing description.
Instead, they use a stock description from a catalog available
through eBay. (GetSingleItem doesn’t return this stock information.)

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

discountPriceInfo

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
applies to only fixed price, BIN items. STP is available on the US, UK, and German
(DE) 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
“sepcial account flag” (SAF) that allows them to apply Discount Pricing to both MSKU
and Non-MSKU items.

@property (nonatomic, retain) Shopping_DiscountPriceInfoType *discountPriceInfo

Discussion

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
applies to only fixed price, BIN items. STP is available on the US, UK, and German
(DE) 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
“sepcial account flag” (SAF) that allows them to apply Discount Pricing to both MSKU
and Non-MSKU items.

type : class Shopping_DiscountPriceInfoType

Declared In

Shopping_SimpleItemType.h

distanceFromBuyer

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.

@property (nonatomic, retain) Shopping_DistanceType *distanceFromBuyer

Discussion

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.

type : class Shopping_DistanceType

Declared In

Shopping_SimpleItemType.h

endTime

Time stamp (in GMT)
of when the listing is scheduled to end, or time stamp of the actual end time
(if the item ended).

@property (nonatomic, retain) NSDate *endTime

Discussion

Time stamp (in GMT)
of when the listing is scheduled to end, or time stamp of the actual end time
(if the item ended).

type : NSDate, wrapper for primitive date

Declared In

Shopping_SimpleItemType.h

excludeShipToLocation

Use this field to specify an international country or region, or a special domestic
location (for sites supporting this feature, currently US, UK, DE) to where you
will not ship the associated item. On input, repeat this element for each
location that you want to exclude as a shipping destination for your item.



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



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



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



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



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



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



Note:
To enable your default Exclude Ship-To List, you must enable Exclude
Shipping Locations and Buyer Requirements in your My eBay Site Preferences.
For details, see the KnowledgeBase Article <a href=
https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1495”

HowTo: ExcludeShipToLocation.

@property (nonatomic, retain) NSMutableArray *excludeShipToLocation

Discussion

Use this field to specify an international country or region, or a special domestic
location (for sites supporting this feature, currently US, UK, DE) to where you
will not ship the associated item. On input, repeat this element for each
location that you want to exclude as a shipping destination for your item.



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



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



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



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



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



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



Note:
To enable your default Exclude Ship-To List, you must enable Exclude
Shipping Locations and Buyer Requirements in your My eBay Site Preferences.
For details, see the KnowledgeBase Article <a href=
https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1495”

HowTo: ExcludeShipToLocation.

entry type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

galleryURL

URL for a picture used as the Gallery thumbnail, if any. The image uses
one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only
returned if the seller chose to show a gallery image.

@property (nonatomic, retain) NSString *galleryURL

Discussion

URL for a picture used as the Gallery thumbnail, if any. The image uses
one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only
returned if the seller chose to show a gallery image.

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

germanMotorsSearchable

The item is featured in eBay search results on the mobile.de partner site.
Applicable to eBay Germany.

@property (nonatomic, retain) NSNumber *germanMotorsSearchable

Discussion

The item is featured in eBay search results on the mobile.de partner site.
Applicable to eBay Germany.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

getItFast

A Get It Fast listing.

@property (nonatomic, retain) NSNumber *getItFast

Discussion

A Get It Fast listing.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

gift

If true, a generic gift icon displays next the listing’s title in search and
browse pages.

@property (nonatomic, retain) NSNumber *gift

Discussion

If true, a generic gift icon displays next the listing’s title in search and
browse pages.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

globalShipping

Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of <strong>GlobalShipping</strong> is <code>true</code>, 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 <strong>GlobalShipping</strong> is <code>false</code>, the seller is responsible for specifying an international shipping service for the listing if desired.  
@property (nonatomic, retain) NSNumber *globalShipping

Discussion

Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of <strong>GlobalShipping</strong> is <code>true</code>, 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 <strong>GlobalShipping</strong> is <code>false</code>, the seller is responsible for specifying an international shipping service for the listing if desired.  

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

halfItemCondition

Returns the Half.com condition code for the item. For example, “brand new,"
"used,” etc.

@property (nonatomic, retain) NSString *halfItemCondition

Discussion

Returns the Half.com condition code for the item. For example, “brand new,"
"used,” etc.

type: string constant in Shopping_HalfItemConditionCodeType.h

Declared In

Shopping_SimpleItemType.h

handlingTime

Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. When listing the item the seller sets this to a positive integer value (1, 2, 3, 4, 5, 10, 15, or 20) corresponding to the number of days. This time does not include the shipping time (the carrier’s transit time). GetSingleItem or GetMultipleItems returns HandlingTime only when shipping service options are specified for the item and the seller specified a handling time.




Valid for flat and calculated shipping. Does not apply when there is no shipping, or when using local pickup only or freight shipping.

@property (nonatomic, retain) NSNumber *handlingTime

Discussion

Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. When listing the item the seller sets this to a positive integer value (1, 2, 3, 4, 5, 10, 15, or 20) corresponding to the number of days. This time does not include the shipping time (the carrier’s transit time). GetSingleItem or GetMultipleItems returns HandlingTime only when shipping service options are specified for the item and the seller specified a handling time.




Valid for flat and calculated shipping. Does not apply when there is no shipping, or when using local pickup only or freight shipping.

type : NSNumber, wrapper for primitive int

Declared In

Shopping_SimpleItemType.h

highBidder

The high bidder for comptetitive-bidding auctions that have ended and have a winning
bidder. This indicates the user who purchased the item.




Not returned for auctions that have received no bids, or for fixed price and
Store Inventory listings that are still active.

@property (nonatomic, retain) Shopping_SimpleUserType *highBidder

Discussion

The high bidder for comptetitive-bidding auctions that have ended and have a winning
bidder. This indicates the user who purchased the item.




Not returned for auctions that have received no bids, or for fixed price and
Store Inventory listings that are still active.

type : class Shopping_SimpleUserType

Declared In

Shopping_SimpleItemType.h

hitCount

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.




Not applicable to Half.com

@property (nonatomic, retain) NSNumber *hitCount

Discussion

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.




Not applicable to Half.com

type : NSNumber, wrapper for primitive long

Declared In

Shopping_SimpleItemType.h

integratedMerchantCreditCardEnabled

Indicates whether the item can be paid for through a payment gateway account. If
IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card is
enabled for credit cards because the seller has a payment gateway account. Therefore,
if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is
returned for an item, then on checkout, an online credit-card payment is processed
through a payment gateway account.

@property (nonatomic, retain) NSNumber *integratedMerchantCreditCardEnabled

Discussion

Indicates whether the item can be paid for through a payment gateway account. If
IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card is
enabled for credit cards because the seller has a payment gateway account. Therefore,
if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is
returned for an item, then on checkout, an online credit-card payment is processed
through a payment gateway account.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

itemID

The ID that uniquely identifies the item listing. eBay generates this ID
when an item is listed. This ID is unique across all eBay sites.

@property (nonatomic, retain) NSString *itemID

Discussion

The ID that uniquely identifies the item listing. eBay generates this ID
when an item is listed. This ID is unique across all eBay sites.

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

itemSpecifics

Category-specific fields that the seller added to describe
the listing. The names of these fields are different for items
in different categories, so they’re returned in a generic
Name/Value structure. The field names are usually very well known
within the category.




For example, a book’s item specifics might include a field like
Publication Year=2007 (where Publication Year is returned in Name, and
2007 is returned in Value), and a field like Format=Hardcover. But a car's
item specifics would be different from a book’s, with fields like Make=
Toyota and Model=Prius. And a ticket’s item specifics would be different
from those of books and cars, with fields like EventType=Concerts and
Venue=The Fillmore.




One of the most common uses for item specifics is the item condition.




Only returned if the seller included Item Specifics in the listing.



Note:
Starting in May 2010, many categories in Production and Sandbox
will start returning the item condition in ConditionID and
ConditionDisplayName instead, if the seller used ConditionID
instead of ItemSpecifics.
Monitor the eBay Developers Program
newsletter for details and timing.

@property (nonatomic, retain) Shopping_NameValueListArrayType *itemSpecifics

Discussion

Category-specific fields that the seller added to describe
the listing. The names of these fields are different for items
in different categories, so they’re returned in a generic
Name/Value structure. The field names are usually very well known
within the category.




For example, a book’s item specifics might include a field like
Publication Year=2007 (where Publication Year is returned in Name, and
2007 is returned in Value), and a field like Format=Hardcover. But a car's
item specifics would be different from a book’s, with fields like Make=
Toyota and Model=Prius. And a ticket’s item specifics would be different
from those of books and cars, with fields like EventType=Concerts and
Venue=The Fillmore.




One of the most common uses for item specifics is the item condition.




Only returned if the seller included Item Specifics in the listing.



Note:
Starting in May 2010, many categories in Production and Sandbox
will start returning the item condition in ConditionID and
ConditionDisplayName instead, if the seller used ConditionID
instead of ItemSpecifics.
Monitor the eBay Developers Program
newsletter for details and timing.

type : class Shopping_NameValueListArrayType

Declared In

Shopping_SimpleItemType.h

listingStatus

Specifies a listing’s status in eBay’s processing workflow.
If an item’s EndTime is in the past, but no details about the
buyer or high bidder are shown (and the user is not anonymous),
use this listing status information to determine whether eBay has
finished processing the listing.

@property (nonatomic, retain) NSString *listingStatus

Discussion

Specifies a listing’s status in eBay’s processing workflow.
If an item’s EndTime is in the past, but no details about the
buyer or high bidder are shown (and the user is not anonymous),
use this listing status information to determine whether eBay has
finished processing the listing.

type: string constant in Shopping_ListingStatusCodeType.h

Declared In

Shopping_SimpleItemType.h

listingType

The format of the listing, such as online auction, fixed price,
or advertisement format.

@property (nonatomic, retain) NSString *listingType

Discussion

The format of the listing, such as online auction, fixed price,
or advertisement format.

type: string constant in Shopping_ListingTypeCodeType.h

Declared In

Shopping_SimpleItemType.h

location

Physical location of the item, as specified by the seller.
(This gives a general indication of where the item will be
shipped or delivered from.)

@property (nonatomic, retain) NSString *location

Discussion

Physical location of the item, as specified by the seller.
(This gives a general indication of where the item will be
shipped or delivered from.)

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

lotSize

A lot is a set of two or more similar items that must be purchased together in
a single transaction. A listing can have multiple lots (instead of multiple
items). When LotSize is specified, the listing price reflects the price of
each lot (not each item within the lot). In this case, Quantity indicates the
number of lots being listed, and LotSize indicates the number of items in each
lot. (If a listing has no lots, Quantity indicates the number of separate
items being listed.) Important: Lot items can be listed only in lot-enabled
categories. GetCategories returns lot size disabled with a value of true
for categories that do not support lots.



Not applicable to Half.com.

@property (nonatomic, retain) NSNumber *lotSize

Discussion

A lot is a set of two or more similar items that must be purchased together in
a single transaction. A listing can have multiple lots (instead of multiple
items). When LotSize is specified, the listing price reflects the price of
each lot (not each item within the lot). In this case, Quantity indicates the
number of lots being listed, and LotSize indicates the number of items in each
lot. (If a listing has no lots, Quantity indicates the number of separate
items being listed.) Important: Lot items can be listed only in lot-enabled
categories. GetCategories returns lot size disabled with a value of true
for categories that do not support lots.



Not applicable to Half.com.

type : NSNumber, wrapper for primitive int

Declared In

Shopping_SimpleItemType.h

minimumToBid

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
competitive-bid auction listings. Returns null for basic Fixed Price
(FixedPriceItem) and Ad type listings.

@property (nonatomic, retain) Shopping_AmountType *minimumToBid

Discussion

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
competitive-bid auction listings. Returns null for basic Fixed Price
(FixedPriceItem) and Ad type listings.

type : class Shopping_AmountType

Declared In

Shopping_SimpleItemType.h

paymentAllowedSite

Enables you to view the sites on which an item can be purchased,
based on the payment methods offered for the item.

@property (nonatomic, retain) NSMutableArray *paymentAllowedSite

Discussion

Enables you to view the sites on which an item can be purchased,
based on the payment methods offered for the item.

entry type : string constant in Shopping_SiteCodeType.h

Declared In

Shopping_SimpleItemType.h

paymentMethods

Identifies the payment method (such as PayPal) the seller
will accept when the buyer pays for the item.



Note:
If the seller only accepts PayPal, the buyer can still pay
with a credit card. PayPal supports major credit cards.



Payment methods are not applicable to eBay Real Estate advertisement
listings, or other Classified Ad format listings.

@property (nonatomic, retain) NSMutableArray *paymentMethods

Discussion

Identifies the payment method (such as PayPal) the seller
will accept when the buyer pays for the item.



Note:
If the seller only accepts PayPal, the buyer can still pay
with a credit card. PayPal supports major credit cards.



Payment methods are not applicable to eBay Real Estate advertisement
listings, or other Classified Ad format listings.

entry type : string constant in Shopping_BuyerPaymentMethodCodeType.h

Declared In

Shopping_SimpleItemType.h

pictureExists

Returns true if the item has an associated picture. Not returned
if value is false.

@property (nonatomic, retain) NSNumber *pictureExists

Discussion

Returns true if the item has an associated picture. Not returned
if value is false.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

pictureURL

Contains the URL for an image associated with the item, if any.
Returned only if the seller included at least one picture
in their listing. Note that this element does not return the URLs of
pictures that the seller included in the Description via HTML IMG tags.




Items listed the main eBay site can have a maximum of 12 picture URLs
hosted by eBay Picture Services, or a maximum of 6 picture URLs hosted by a
third party (such as the a photo site). Note that a listing can have up to
24 picture URLs on the US eBay Motors site (for all vehicle listings),
and on the eBay Canada Motors site.




eBay uses the seller’s first picture at the top of the listing's
View Item page.

@property (nonatomic, retain) NSMutableArray *pictureURL

Discussion

Contains the URL for an image associated with the item, if any.
Returned only if the seller included at least one picture
in their listing. Note that this element does not return the URLs of
pictures that the seller included in the Description via HTML IMG tags.




Items listed the main eBay site can have a maximum of 12 picture URLs
hosted by eBay Picture Services, or a maximum of 6 picture URLs hosted by a
third party (such as the a photo site). Note that a listing can have up to
24 picture URLs on the US eBay Motors site (for all vehicle listings),
and on the eBay Canada Motors site.




eBay uses the seller’s first picture at the top of the listing's
View Item page.

entry type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

postalCode

Postal code indicating the physical location of the item,
as specified by the seller. (This gives a general indication of where
the item will be shipped or delivered from.)

@property (nonatomic, retain) NSString *postalCode

Discussion

Postal code indicating the physical location of the item,
as specified by the seller. (This gives a general indication of where
the item will be shipped or delivered from.)

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

primaryCategoryID

Numeric ID of the first (or only) category in which the item is listed.
(Listings can appear in more than one category.)

@property (nonatomic, retain) NSString *primaryCategoryID

Discussion

Numeric ID of the first (or only) category in which the item is listed.
(Listings can appear in more than one category.)

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

primaryCategoryIDPath

The fully qualified ID breadcrumb (path) of the first category.
For example, if the primary category ID is 45678, and its parent
category’s ID is 123, the breadcrumb (path) would be 123:45678.

@property (nonatomic, retain) NSString *primaryCategoryIDPath

Discussion

The fully qualified ID breadcrumb (path) of the first category.
For example, if the primary category ID is 45678, and its parent
category’s ID is 123, the breadcrumb (path) would be 123:45678.

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

primaryCategoryName

Display name of the first (or only) category in which the item is
listed. This is a fully qualified category breadcrumb
(e.g., Computers & Networking:Laptops, Notebooks).

@property (nonatomic, retain) NSString *primaryCategoryName

Discussion

Display name of the first (or only) category in which the item is
listed. This is a fully qualified category breadcrumb
(e.g., Computers & Networking:Laptops, Notebooks).

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

productID

A prototype description of a well-known type of item, such as a popular book.




When returned for GetSingleItem, is always of type Reference, and serves as a global
reference ID for an eBay catalog product.




When used as input, retrieves product details for one specific product. Specify the
ID as a string, and use the type attribute to indicate the nature of the ID you are
specifying.




The request requires either QueryKeywords or
ProductID, but these fields cannot be used together.

@property (nonatomic, retain) Shopping_ProductIDType *productID

Discussion

A prototype description of a well-known type of item, such as a popular book.




When returned for GetSingleItem, is always of type Reference, and serves as a global
reference ID for an eBay catalog product.




When used as input, retrieves product details for one specific product. Specify the
ID as a string, and use the type attribute to indicate the nature of the ID you are
specifying.




The request requires either QueryKeywords or
ProductID, but these fields cannot be used together.

type : class Shopping_ProductIDType

Declared In

Shopping_SimpleItemType.h

quantity

The number of items the seller is offering in the listing. (Subtract
Item.QuantitySold from this value to calculate the number of items
currently available for sale.)




An online, comptetitive-bidding auction with a Quantity of 1 is referred to as a <
i>Chinese auction. Basic fixed-price and Store Inventory listings can
have a Quantity of 1 or more.




The listing’s current or Buy It Now price is the price of the item in the
listing.




Note:
A seller can also offer multiple items for sale with a single
price for all the items. For example, instead of listing 10 lightbulbs
for US 2.00 each, they might list 10 lightbulbs for USD 20.00 (where
you have to buy all 10). This is called a “lot."




If the listing includes a lot, Quantity does not specify the lot size; it
reflects how many lots are being sold. For example, if the original listing
included 5 lots of 10 lightbulbs each, Quantity would be 5.


@property (nonatomic, retain) NSNumber *quantity

Discussion

The number of items the seller is offering in the listing. (Subtract
Item.QuantitySold from this value to calculate the number of items
currently available for sale.)




An online, comptetitive-bidding auction with a Quantity of 1 is referred to as a <
i>Chinese auction. Basic fixed-price and Store Inventory listings can
have a Quantity of 1 or more.




The listing’s current or Buy It Now price is the price of the item in the
listing.




Note:
A seller can also offer multiple items for sale with a single
price for all the items. For example, instead of listing 10 lightbulbs
for US 2.00 each, they might list 10 lightbulbs for USD 20.00 (where
you have to buy all 10). This is called a “lot."




If the listing includes a lot, Quantity does not specify the lot size; it
reflects how many lots are being sold. For example, if the original listing
included 5 lots of 10 lightbulbs each, Quantity would be 5.


type : NSNumber, wrapper for primitive int

Declared In

Shopping_SimpleItemType.h

quantityAvailableHint

Indicates the type of message that will be returned describing the quantity
available for the item.

@property (nonatomic, retain) NSString *quantityAvailableHint

Discussion

Indicates the type of message that will be returned describing the quantity
available for the item.

type: string constant in Shopping_QuantityAvailableHintCodeType.h

Declared In

Shopping_SimpleItemType.h

quantityInfo

This container consists of the MinimumRemnantSet
field, which sets 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.

@property (nonatomic, retain) Shopping_QuantityInfo *quantityInfo

Discussion

This container consists of the MinimumRemnantSet
field, which sets 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.

type : class Shopping_QuantityInfo

Declared In

Shopping_SimpleItemType.h

quantitySold

Number of items purchased so far from this listing. (Subtract this value from
Item.Quantity to calculate the number of items currently available for sale.)

@property (nonatomic, retain) NSNumber *quantitySold

Discussion

Number of items purchased so far from this listing. (Subtract this value from
Item.Quantity to calculate the number of items currently available for sale.)

type : NSNumber, wrapper for primitive int

Declared In

Shopping_SimpleItemType.h

quantityThreshold

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.

@property (nonatomic, retain) NSNumber *quantityThreshold

Discussion

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.

type : NSNumber, wrapper for primitive int

Declared In

Shopping_SimpleItemType.h

recentListing

Returns true if the item listing is no more than one day old. Not returned
if value is false.

@property (nonatomic, retain) NSNumber *recentListing

Discussion

Returns true if the item listing is no more than one day old. Not returned
if value is false.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

reserveMet

Indicates whether any bids on this item are greater than the seller's
reserve price for the listing (if any).




A reserve is the lowest price at which the seller is willing to sell
the item. The reserve price is higher than the listing’s opening bid
(minimum bid) and lower than the Buy It Now price, if any.
(The reserve price is only known to the seller.)
Some sellers don’t set a reserve at all. If a listing does have
a reserve price, the highest bidder will only win
the item if their bid is also above that price.




Only returned for online auctions that have a reserve price. (Fixed price, Store
Inventory, and classified ad listings don’t have reserve prices.)

@property (nonatomic, retain) NSNumber *reserveMet

Discussion

Indicates whether any bids on this item are greater than the seller's
reserve price for the listing (if any).




A reserve is the lowest price at which the seller is willing to sell
the item. The reserve price is higher than the listing’s opening bid
(minimum bid) and lower than the Buy It Now price, if any.
(The reserve price is only known to the seller.)
Some sellers don’t set a reserve at all. If a listing does have
a reserve price, the highest bidder will only win
the item if their bid is also above that price.




Only returned for online auctions that have a reserve price. (Fixed price, Store
Inventory, and classified ad listings don’t have reserve prices.)

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

returnPolicy

If a seller specified return policy details, then this container has fields with
those details. The fields that can be returned in this container vary by site.

@property (nonatomic, retain) Shopping_ReturnPolicyType *returnPolicy

Discussion

If a seller specified return policy details, then this container has fields with
those details. The fields that can be returned in this container vary by site.

type : class Shopping_ReturnPolicyType

Declared In

Shopping_SimpleItemType.h

secondaryCategoryID

ID of the second category in which the item is listed. Returned only if
the seller listed a second category.

@property (nonatomic, retain) NSString *secondaryCategoryID

Discussion

ID of the second category in which the item is listed. Returned only if
the seller listed a second category.

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

secondaryCategoryIDPath

The fully qualified ID breadcrumb (path) of the second category. For example, if the
secondary category ID is 45678, and its parent category’s ID is 123, the breadcrumb
(path) would be 123:45678. Returned only if the seller listed a second category.

@property (nonatomic, retain) NSString *secondaryCategoryIDPath

Discussion

The fully qualified ID breadcrumb (path) of the second category. For example, if the
secondary category ID is 45678, and its parent category’s ID is 123, the breadcrumb
(path) would be 123:45678. Returned only if the seller listed a second category.

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

secondaryCategoryName

Name of the second category in which the item is listed. Returned only if
the seller listed a second category.

@property (nonatomic, retain) NSString *secondaryCategoryName

Discussion

Name of the second category in which the item is listed. Returned only if
the seller listed a second category.

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

seller

Container for information about this listing’s seller.

@property (nonatomic, retain) Shopping_SimpleUserType *seller

Discussion

Container for information about this listing’s seller.

type : class Shopping_SimpleUserType

Declared In

Shopping_SimpleItemType.h

sellerComments

Notes that the Seller made when they listed the item. Not returned if the Seller
did not make any comments.

@property (nonatomic, retain) NSString *sellerComments

Discussion

Notes that the Seller made when they listed the item. Not returned if the Seller
did not make any comments.

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

shipToLocations

An international location or region to which the seller is willing
to ship this item. Returned only for items that have ShipToLocations
specified.




Applicable values:

•   Americas

(North, South, or Latin America)

•   Asia

•   Caribbean

•   Europe

•   EuropeanUnion

•   LatinAmerica

•   MiddleEast

•   NorthAmerica

•   Oceania

(Pacific region other than Asia)

•   SouthAmerica

•   WillNotShip

(No shipping, buyer must pick up the item)

•   Worldwide

(Seller will ship worldwide)

•   2-letter [country](#//api/name/country) identifier

(See CountryCodeType for values)

@property (nonatomic, retain) NSMutableArray *shipToLocations

Discussion

An international location or region to which the seller is willing
to ship this item. Returned only for items that have ShipToLocations
specified.




Applicable values:

•   Americas

(North, South, or Latin America)

•   Asia

•   Caribbean

•   Europe

•   EuropeanUnion

•   LatinAmerica

•   MiddleEast

•   NorthAmerica

•   Oceania

(Pacific region other than Asia)

•   SouthAmerica

•   WillNotShip

(No shipping, buyer must pick up the item)

•   Worldwide

(Seller will ship worldwide)

•   2-letter [country](#//api/name/country) identifier

(See CountryCodeType for values)

entry type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

shippingCostSummary

Contains basic shipping-related costs for the item. If Item.Quantity
is greater than 1, this is the shipping cost for one item.
If the seller offers a choice of more than one shipping service
(such as UPS Ground and USPS Media mail), this is the cost of the
“first” shipping option (usually the lowest cost option).




If a listing has shipping costs, use GetShippingCosts if you want to get
more details about the services and costs that the seller is offering.

@property (nonatomic, retain) Shopping_ShippingCostSummaryType *shippingCostSummary

Discussion

Contains basic shipping-related costs for the item. If Item.Quantity
is greater than 1, this is the shipping cost for one item.
If the seller offers a choice of more than one shipping service
(such as UPS Ground and USPS Media mail), this is the cost of the
“first” shipping option (usually the lowest cost option).




If a listing has shipping costs, use GetShippingCosts if you want to get
more details about the services and costs that the seller is offering.

type : class Shopping_ShippingCostSummaryType

Declared In

Shopping_SimpleItemType.h

site

The name of the eBay site 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.




The listing’s original site can affect the values of converted
(localized) prices (when your request specifies a site
that is different from the listing’s site).

@property (nonatomic, retain) NSString *site

Discussion

The name of the eBay site 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.




The listing’s original site can affect the values of converted
(localized) prices (when your request specifies a site
that is different from the listing’s site).

type: string constant in Shopping_SiteCodeType.h

Declared In

Shopping_SimpleItemType.h

startTime

Time stamp (in GMT) that
eBay recorded as the moment that the listing was made available.
The start time returned by a search call may vary
from the value returned by GetSingleItem.

@property (nonatomic, retain) NSDate *startTime

Discussion

Time stamp (in GMT) that
eBay recorded as the moment that the listing was made available.
The start time returned by a search call may vary
from the value returned by GetSingleItem.

type : NSDate, wrapper for primitive date

Declared In

Shopping_SimpleItemType.h

storefront

Returns the seller’s store information if the seller has an eBay store.
Returns a blank store if the seller does not have an eBay storefront.

@property (nonatomic, retain) Shopping_StorefrontType *storefront

Discussion

Returns the seller’s store information if the seller has an eBay store.
Returns a blank store if the seller does not have an eBay storefront.

type : class Shopping_StorefrontType

Declared In

Shopping_SimpleItemType.h

subtitle

Subtitle of the item. Only returned if the seller included a
subtitle for the listing.




For US eBay Motors passenger vehicle, motorcycle, and “other vehicle"
categories or listings in CA eBay Motors passenger vehicle and
motorcycle categories, the seller’s subtitle is only available
in the Item.ItemSpecifics node. Call GetSingleItem with
IncludeSelector=ItemSpecifics to retrieve a listing’s Item Specifics.

@property (nonatomic, retain) NSString *subtitle

Discussion

Subtitle of the item. Only returned if the seller included a
subtitle for the listing.




For US eBay Motors passenger vehicle, motorcycle, and “other vehicle"
categories or listings in CA eBay Motors passenger vehicle and
motorcycle categories, the seller’s subtitle is only available
in the Item.ItemSpecifics node. Call GetSingleItem with
IncludeSelector=ItemSpecifics to retrieve a listing’s Item Specifics.

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

timeLeft

Time left before the listing ends.
The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS).
For ended listings, the time left is PT0S (zero seconds).

@property (nonatomic, retain) NSString *timeLeft

Discussion

Time left before the listing ends.
The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS).
For ended listings, the time left is PT0S (zero seconds).

type : NSString, wrapper for primitive duration

Declared In

Shopping_SimpleItemType.h

title

Name of the item as it appears in the listing or in search and
browse results.




For US eBay Motors vehicles only: In item-retrieval
calls (like GetSingleItem and GetMultipleItems), this value shows the
vehicle Make and Model (e.g., “Buick : Skylark”).




Note:
GetSingleItem does not return the same Item.Title
value for US eBay Motors listings. Here’s why:




In general, GetSingleItem maps to eBay’s View Item page. The eBay Motors
Web site’s View Item page shows two vehicle titles in the title bar: One
title is a label based on the Year, Make, Model, and Submodel (e.g.,
“1996 Buick Skylark Limited”). The model is included unless it’s “Other"
or unspecified. The submodel is included if the seller specified a
submodel. The other title is a path based on the Make and Model (e.g.,
"Buick : Skylark”). The Item.Title value in GetSingleItem maps to this
path.


@property (nonatomic, retain) NSString *title

Discussion

Name of the item as it appears in the listing or in search and
browse results.




For US eBay Motors vehicles only: In item-retrieval
calls (like GetSingleItem and GetMultipleItems), this value shows the
vehicle Make and Model (e.g., “Buick : Skylark”).




Note:
GetSingleItem does not return the same Item.Title
value for US eBay Motors listings. Here’s why:




In general, GetSingleItem maps to eBay’s View Item page. The eBay Motors
Web site’s View Item page shows two vehicle titles in the title bar: One
title is a label based on the Year, Make, Model, and Submodel (e.g.,
“1996 Buick Skylark Limited”). The model is included unless it’s “Other"
or unspecified. The submodel is included if the seller specified a
submodel. The other title is a path based on the Make and Model (e.g.,
"Buick : Skylark”). The Item.Title value in GetSingleItem maps to this
path.


type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

topRatedListing

This field is only applicable to the US site, and will only be returned if the US
seller qualifies as a Top-Rated Seller. The current requirements for US sellers to
qualify as Top-Rated Sellers are:

  • 100 or more selling transactions per year
  • Shipment tracking information provided to buyer within handling time for at least 90 percent of their listings




If this flag is returned for a listing, it indicates that the listing meets the new
requirements for a Top-Rated Listing. A Top-Rated Listing must meet the following
requirements:

  • 14-day (or longer) return policy with Money Back option
  • 1-day Handling Time or better




A new Top-Rated Plus seal will start appearing on the View Item
page for all Top-Rated Listings beginning in November 2012. This seal will
replace the Top-Rated Seller badge. US Top-Rated Sellers get a
20 percent discount on their FVF for all listings that qualify as Top-Rated Listings.

@property (nonatomic, retain) NSNumber *topRatedListing

Discussion

This field is only applicable to the US site, and will only be returned if the US
seller qualifies as a Top-Rated Seller. The current requirements for US sellers to
qualify as Top-Rated Sellers are:

  • 100 or more selling transactions per year
  • Shipment tracking information provided to buyer within handling time for at least 90 percent of their listings




If this flag is returned for a listing, it indicates that the listing meets the new
requirements for a Top-Rated Listing. A Top-Rated Listing must meet the following
requirements:

  • 14-day (or longer) return policy with Money Back option
  • 1-day Handling Time or better




A new Top-Rated Plus seal will start appearing on the View Item
page for all Top-Rated Listings beginning in November 2012. This seal will
replace the Top-Rated Seller badge. US Top-Rated Sellers get a
20 percent discount on their FVF for all listings that qualify as Top-Rated Listings.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

unitInfo

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.   
<br/><br/>  
               <span class="tablenote">  
               <strong>Note:</strong> This information is currently required only for business sellers, and only for listings with a Buy It Now option.  
               </span>  
@property (nonatomic, retain) Shopping_UnitInfoType *unitInfo

Discussion

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.   
<br/><br/>  
               <span class="tablenote">  
               <strong>Note:</strong> This information is currently required only for business sellers, and only for listings with a Buy It Now option.  
               </span>  

type : class Shopping_UnitInfoType

Declared In

Shopping_SimpleItemType.h

variations

Variations are multiple similar (but not identical) items in a single fixed-price (or
Store Inventory Format) listing. For example, a single listing could contain multiple
items of the same brand and model that vary by color and size (like “Blue, Large” and
“Black, Medium”). Each variation can have its own quantity and price. Only returned
if the listing contains multiple variations.

@property (nonatomic, retain) Shopping_VariationsType *variations

Discussion

Variations are multiple similar (but not identical) items in a single fixed-price (or
Store Inventory Format) listing. For example, a single listing could contain multiple
items of the same brand and model that vary by color and size (like “Blue, Large” and
“Black, Medium”). Each variation can have its own quantity and price. Only returned
if the listing contains multiple variations.

type : class Shopping_VariationsType

Declared In

Shopping_SimpleItemType.h

vhrAvailable

If true, the eBay Motors item has a Vehicle History Report
associated with it.

@property (nonatomic, retain) NSNumber *vhrAvailable

Discussion

If true, the eBay Motors item has a Vehicle History Report
associated with it.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_SimpleItemType.h

vhrUrl

The URL to the eBay Motors item’s full Vehicle History Report.
Only returned when the item has a Vehicle History Report.

@property (nonatomic, retain) NSString *vhrUrl

Discussion

The URL to the eBay Motors item’s full Vehicle History Report.
Only returned when the item has a Vehicle History Report.

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

viewItemURLForNaturalSearch

The URL to view this listing on eBay. 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. For example, this URL specifies the item title, and
it is optimized for natural search: “_W0QQ” is like “?” (question mark), “QQ” is like
“&” (ampersand), and “Z” is like “=” (equals sign). You shouldn’t modify the
query syntax in your application. For example, eBay won’t recognize the URL if you
change QQ to ?.

@property (nonatomic, retain) NSString *viewItemURLForNaturalSearch

Discussion

The URL to view this listing on eBay. 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. For example, this URL specifies the item title, and
it is optimized for natural search: “_W0QQ” is like “?” (question mark), “QQ” is like
“&” (ampersand), and “Z” is like “=” (equals sign). You shouldn’t modify the
query syntax in your application. For example, eBay won’t recognize the URL if you
change QQ to ?.

type : NSString, wrapper for primitive string

Declared In

Shopping_SimpleItemType.h

watchCount

Number of users who have placed the item on their Watch list.

@property (nonatomic, retain) NSNumber *watchCount

Discussion

Number of users who have placed the item on their Watch list.

type : NSNumber, wrapper for primitive int

Declared In

Shopping_SimpleItemType.h