Class SimpleItemType

class SimpleItemType

Defined in com/ebay/shoppingservice/SimpleItemType.js

Property Summary
Boolean autoPay
If true, the seller requires immediate payment for the item.
Boolean bestOfferEnabled
Whether the seller will accept a best offer for this item.
Number bidCount
The number of bids that have been placed on the item.
BusinessSellerDetailsType businessSellerDetails
Returns the seller's business information.
Boolean buyItNowAvailable
Indicates whether the item has an active Buy It Now option.
AmountType buyItNowPrice
The Buy It Now price of the item, returned in the currency of the site on which the item was listed.
CharityType charity
Identifier for a Giving Works listing and the benefiting nonprofit charity organization.
AmountType convertedBuyItNowPrice
The listing's Buy It Now Price (if any), converted into the currency of the site to which you sent this request.
AmountType convertedCurrentPrice
The listing's Buy It Now Price (if any), converted into the currency of the site to which you sent this request.
CountryCodeType country
Two-letter ISO 3166 country code to indicate the country where the item is located.
AmountType currentPrice
The current price of the item in the currency of the site on which the item was listed.
String description
The seller's description of the item, if any.
DistanceType distanceFromBuyer
The distance of the item from the buyer.
Date 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).
String galleryURL
URL for a picture used as the Gallery thumbnail, if any.
Boolean germanMotorsSearchable
The item is featured in eBay search results on the mobile.de partner site.
Boolean getItFast
A Get It Fast listing.
Boolean gift
If true, a generic gift icon displays next the listing's title in search and browse pages.
HalfItemConditionCodeType halfItemCondition
Returns the Half.com condition code for the item.
Number handlingTime
Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment.
SimpleUserType highBidder
The high bidder for comptetitive-bidding auctions that have ended and have a winning bidder.
Number hitCount
The number of times the listing's View Item page has been viewed (as determined by eBay).
Boolean integratedMerchantCreditCardEnabled
Indicates whether the item can be paid for through a payment gateway account.
String itemID
The ID that uniquely identifies the item listing.
NameValueListArrayType itemSpecifics
Category-specific fields that the seller added to describe the listing.
ListingStatusCodeType listingStatus
Specifies a listing's status in eBay's processing workflow.
ListingTypeCodeType listingType
The format of the listing, such as online auction, fixed price, or advertisement format.
String location
Physical location of the item, as specified by the seller.
Number lotSize
A lot is a set of two or more similar items that must be purchased together in a single transaction.
AmountType minimumToBid
Smallest amount the next bid on the item can be.
Array paymentAllowedSite
Enables you to view the sites on which an item can be purchased, based on the payment methods offered for the item.
Array paymentMethods
Identifies the payment method (such as PayPal) the seller will accept when the buyer pays for the item.
Boolean pictureExists
Returns true if the item has an associated picture.
Array pictureURL
Contains the URL for an image associated with the item, if any.
String postalCode
Postal code indicating the physical location of the item, as specified by the seller.
String primaryCategoryID
Numeric ID of the first (or only) category in which the item is listed.
String primaryCategoryIDPath
The fully qualified ID breadcrumb (path) of the first category.
String primaryCategoryName
Display name of the first (or only) category in which the item is listed.
ProductIDType productID
A prototype description of a well-known type of item, such as a popular book.
Number quantity
The number of items the seller is offering in the listing.
Number quantitySold
Number of items purchased so far from this listing.
Boolean recentListing
Returns true if the item listing is no more than one day old.
Boolean reserveMet
Indicates whether any bids on this item are greater than the seller's reserve price for the listing (if any).
ReturnPolicyType returnPolicy
If a seller specified return policy details, then this container has fields with those details.
String secondaryCategoryID
ID of the second category in which the item is listed.
String secondaryCategoryIDPath
The fully qualified ID breadcrumb (path) of the second category.
String secondaryCategoryName
Name of the second category in which the item is listed.
SimpleUserType seller
Container for information about this listing's seller.
String sellerComments
Notes that the Seller made when they listed the item.
Array shipToLocations
An international location or region to which the seller is willing to ship this item.
ShippingCostSummaryType shippingCostSummary
Contains basic shipping-related costs for the item.
SiteCodeType site
The name of the eBay site on which the item was originally listed.
Date startTime
Time stamp (in GMT) that eBay recorded as the moment that the listing was made available.
StorefrontType storefront
Returns the seller's store information if the seller has an eBay store.
String subtitle
Subtitle of the item.
String timeLeft
Time left before the listing ends.
String title
Name of the item as it appears in the listing or in search and browse results.
VariationsType variations
Variations are multiple similar (but not identical) items in a single fixed-price (or Store Inventory Format) listing.
String viewItemURLForNaturalSearch
The URL to view this listing on eBay.
Number watchCount
Number of users who have placed the item on their Watch list.

Constructor Summary
SimpleItemType(Object props)

Property Details

property Boolean 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 Boolean 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 Number 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.

property BusinessSellerDetailsType 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 Boolean 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 AmountType 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 like FindItems will 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.

Some eBay sites also support multi-item Buy It Now items, where you can buy multiple items from the same listing at a fixed price (instead of bidding).

Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1.
For fixed-price (FixedPriceItem) and Store Inventory listings (StoresFixedPrice), see CurrentPrice or ConvertedCurrentPrice instead.

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

property CharityType charity

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

property AmountType 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) and Store Inventory listings (StoresFixedPrice), 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 AmountType 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) and Store Inventory listings (StoresFixedPrice), 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 CountryCodeType country

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

property AmountType 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), Store Inventory (StoresFixedPrice), and Ad format (AdType) listings, this is the current fixed price.

property String description

The seller's description of the item, if any. This can include HTML markup and JavaScript. See 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 DistanceType 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 Date 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). In FindItemsAdvanced and FindItems, for StoresFixedPrice items which are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. The discrepancy is intended to facilitate renewal every 30 days of such items' end times.

In search results (like the FindItemsAdvanced response), the same EndTime may be returned for multiple results if the results are variations from the same multi-variation listing.

property String 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 Boolean germanMotorsSearchable

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

property Boolean getItFast

A Get It Fast listing.

property Boolean gift

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

property HalfItemConditionCodeType halfItemCondition

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

property Number handlingTime

Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. 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 DispatchTimeMax only when shipping service options are specified for the item and the seller specified a dispatch time.

Valid for flat and calculated shipping. Does not apply when there is no shipping, when it is local pickup only or it is freight shipping.
the listing ends, you can add or change the dispatch (handling) time.

property SimpleUserType 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 Number 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 Boolean 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 String 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.

In search results (like the FindItemsAdvanced response), the same ItemID may be returned for multiple results if the results are variations from the same multi-variation listing.

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

property ListingStatusCodeType 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 ListingTypeCodeType listingType

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

property String 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 Number 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 AmountType 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),Store Inventory (StoresFixedPrice), and Ad type listings.

property Array paymentAllowedSite

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

property Array 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 Boolean pictureExists

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

property Array 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 String 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 String primaryCategoryID

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

property String 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 String 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 ProductIDType 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 Number 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 Number 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 Boolean recentListing

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

property Boolean 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 ReturnPolicyType 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 String secondaryCategoryID

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

property String 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 String secondaryCategoryName

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

property SimpleUserType seller

Container for information about this listing's seller.

property String sellerComments

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

property Array 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 identifier

(See CountryCodeType for values)

property ShippingCostSummaryType 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 SiteCodeType 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 Date 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 StorefrontType 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 String 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 String 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).

In search results (like the FindItemsAdvanced response), the same TimeLeft may be returned for multiple results if the results are variations from the same multi-variation listing.

property String 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").

In finding calls (like FindItemsAdvanced), this value concatenates several Item Specifics: The Make (e.g., "Buick"), Model (e.g., Skylark), Submodel (e.g., Limited), and the seller's customized subtitle (e.g., "Great deal!"). Call GetSingleItem with IncludeSelector=ItemSpecifics to see the individual Item Specifics (in Item.ItemSpecifics).

Note: GetSingleItem and FindItemsAdvanced do 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.

In general, FindItemsAdvanced maps to eBay's advanced search functionality. The Item.Title value described above for FindItemsAdvanced maps to the item's search result title in the eBay Motors search results page.

property VariationsType 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 String 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 ?. In the Sandbox environment and on the Hong Kong site (site ID 201), the data returned in this field by FindItemsAdvanced is a standard ViewItem URL, rather than the ViewItem URL for natural search that generally is returned in the Production environment.

In search results (like the FindItemsAdvanced response),if the result is a variation from a multi-variation listing, this link to the View Item page is configured to select the applicable variation.

property Number watchCount

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

Constructor Details

constructor SimpleItemType

SimpleItemType(Object props)

Parameters:
props