Trading_ItemType Class Reference
| Inherits from | NSObject |
| Conforms to | PicoBindable |
| Declared in | Trading_ItemType.h Trading_ItemType.m |
Overview
Contains the data defining one item. A seller populates an object of
this type at listing time with the definition of a new item. A seller
also uses an object of this type to relist or revise an item. Calls
that retrieve item data (such as the GetSellerList call) return an object of
this type, filled with the item’s data. Some fields are applicable both
to eBay listings and Half.com listings. Some fields are only applicable to eBay listings,
and others are only applicable to Half.com listings.
@ingroup EBayAPIInterface
Tasks
-
applicationData
Returns custom, application-specific data associated with the item.
property
The data you specify is stored by eBay with the item for your own
reference, but it is not used by eBay in any way. Use
ApplicationData to store special information for yourself, such as
a part number. For a SKU in an eBay.com listing, use the SKU
element instead. To remove this value when revising or relisting an
item, use DeletedField.
Not applicable to Half.com, use SellerInventoryID instead. -
attributeSetArray
No longer applicable to any categories.
property -
attributeArray
This container is used to specify one or more item attributes for a Half.com listing. This
property
container is not applicable for eBay fixed-price or auction listings.
You can use ReviseItem to modify attribute values for Half.com
listings.
Half.com listing attributes are not returned in GetItem. -
lookupAttributeArray
No longer applicable to any category. Use ConditionID instead.
property -
autoPay
To create an immediate payment listing, AutoPay must be included and
set to ‘true’ for the Add/Revise/Relist API calls. If the seller does not want to create an
immediate payment item, this field is either omitted, or included and set to ‘false’.
In the Trading API calls that return the AutoPay field, be aware that
the field’s appearance in the output does not necessarily indicate that the listing
contains an immediate payment item, but only that the seller attempted to enable (by
including and setting AutoPay to ‘true’ in the request) the immediate
payment option.
In order for a seller to apply an immediate payment policy for an item, the following must
be true:- [seller](#//api/name/seller) must have a Premier or Business PayPal account;
- [seller](#//api/name/seller) must provide a valid Item.PayPalEmailAddress value;
- [seller](#//api/name/seller) must offer 'PayPal' as the only Item.PaymentMethod value;
- the listing [site](#//api/name/site) supports PayPal payments;
- the category supports PayPal payments;
- the listing type is fixed-price or auction (with Buy It Now option)
property
To discover if a category supports immediate payment for an item, use
GetCategories and look for the appearance of
the AutoPayEnabled boolean field in the output for that category
(identified by CategoryID). AutoPayEnabled is
returned as an empty element if the category supports immediate payment, and is
not returned at all if the category does not support immediate payment.
Not applicable to Half.com. -
paymentDetails
This container is used by the seller to specify amounts and due dates for deposits and
property
full payment on motor vehicle listings.
The PaymentDetails container and its child fields are only applicable to vehicle listings
on eBay Motors (US and CA). -
biddingDetails
Detailed information about a bid. For GetMyeBayBuying, returned as
property
a self-closed element if no bids meet the request criteria.
Not applicable to Half.com. -
motorsGermanySearchable
Listing upgrade that features the item in eBay search results on
property
the mobile.de partner site. Applicable to eBay Germany.
If ‘true’ in listing requests and responses, the seller is purchasing
or has purchased cross-promotional placement on the mobile.de site.
Not applicable to Half.com. -
buyerProtection
Flag to indicate an item’s eligibility for the PayPal Buyer Protection
property
program. This field is only returned if ‘true’. If this field is not returned, the item is not eligible for PayPal Buyer Protection. For more information on
items that are eligible for PayPal Buyer Protection, see the
PayPal Buyer Protection help page.
Not applicable to Half.com. -
buyItNowPrice
For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy
property
It Now price and end the auction immediately. Use this field to specify the Buy It Now
price. Including and specifying a BuyItNowPrice value enables the
Buy It Now feature for the auction listing.
There is a minimum percentage value that the Buy It Now price must be set above
the Start Price. This minimum percentage value varies by site. To see the valid values
for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails,
and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response.
If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid.
This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com
listings.
Once an auction has bids (and the high bid exceeds the Reserve Price,
if specified), the listing is no longer eligible for Buy It Now (with some
exceptions noted below). However, calls like GetItem
still return the BuyItNowPrice that the seller originally set for the
listing. Use the GetItem call and look for the inclusion of the
Item.ListingDetails.BuyItNowAvailable flag in the output to determine
whether the item can still be purchased using Buy It Now. You can also view the
Item.SellingStatus.BidCount value in other item retrieval
calls to determine whether an auction with Buy It Now has bids or not.
There might be price limits imposed for Buy It Now items, subject to the
seller’s PayPal account or the payment method used. Such limits cannot be
determined via the eBay API and are not covered in eBay’s API documentation
because they can vary for each user.
To remove this value when revising or relisting an item, use DeletedField. -
categoryMappingAllowed
Controls how eBay handles cases in which an ID specified in
property
PrimaryCategory and/or SecondaryCategory no longer
exists in the current category structure: If you pass a value of ‘true’ in
CategoryMappingAllowed, eBay will look up the current category ID that
is mapped to the same category and use the new category ID for the listing (if any). The
new category ID will be returned in the response as CategoryID (for
the primary category) or Category2ID (for the secondary category). If
CategoryMappingAllowed is not set or contains a value of ‘false’ (the
default), an error will be returned if a selected category ID no longer exists.
Not applicable to Half.com. -
charity
Identifies a Giving Works listing and the benefiting nonprofit charity
property
organization selected by the charity seller (if any). If specified, the
seller must also accept PayPal as a payment method for the item (see
Item.PaymentMethods).
When you revise an item, you can add a charity to a non-charity listing, but
you cannot remove or change the charity designation. The rules for adding a
charity to a listing depend on the listing type. For an auction listing, you
can revise an item to add a charity if there are more than 12 hours left for
the listing (whether or not the item has bids). For a fixed-price listing,
you can revise an item to add a charity if there are more than 12 hours left
for the listing, and the item has not been sold.
When you relist an item, use DeletedField to remove charity
information.
Not applicable to Half.com. -
country
Defines the 2-letter country code set.
property
To see the list of currently supported country
codes, and the English names associated with each code (e.g., KY=“Cayman Islands”),
call GeteBayDetails with DetailName set to CountryDetails,
and then look for CountryDetails.Country fields in the response.
Most of the codes that eBay uses conform to the ISO 3166 standard, but some of the
codes in the ISO 3166 standard are not used by eBay. Plus, there are some non-ISO
codes in the eBay list. (Additional codes appear at the end of this code list and
are noted as non-ISO.)
Also applicable as input to AddItem and related calls when you list
items to Half.com (specify ‘US’). -
crossPromotion
This container is no longer supported as eBay Store Cross Promotions are no
property
longer supported by the Trading API.
Container for cross-promoted items related to a specific item ID.
The items are either upsell or cross-sell, according to the promotion
method passed in the request.
Not applicable to Half.com. -
currency
Currency associated with the item’s price information. 3-letter ISO 4217
property
currency code that corresponds to the site specified in the listing
request. Also applicable as input to AddItem and related calls when you list
items to Half.com (specify USD). You cannot modify a listing’s currency when
you revise or relist an item.
To see the list of currently supported currency codes, call GeteBayDetails
with DetailName set to CurrencyDetails, and then look
for the CurrencyDetails.Currency fields in the response. -
description
The seller’s description of the item.
property
In listing requests, you can submit your description
using CDATA if you want to use HTML or XML-reserved characters in the
description. An error is returned if this contains malicious JavaScript
content. (For more information on eBay’s HTML and JavaScript policy, see the
HTML and JavaScript policy
help topic.)
If you embed pictures in the description (by using IMG tags) instead of using
PictureURL, but you want a camera icon to appear in search and listing pages,
specify the following null-image URL in PictureURL:
http://pics.ebay.com/aw/pics/dot_clear.gif. See “Including Pictures in an Item
Listing” in the Trading API Guide.
Required for all listings, except listings that include eBay catalog product details. Optional when you list with product details and Item.ProductListingDetails.IncludePrefilledItemInformation is true.
Note:
In addition to including notes on flaws or wear and tear on an used item in the
Item.Description, and including a ConditionID
value, you can provide additional information about the condition of your used item
through the Item.ConditionDescription string field.
For GetItem: Item.Description
can be empty when IncludePrefilledItemInformation is true and
the seller did not write their own description. Item.Description doesn’t return pre-filled descriptions from catalogs.
The eBay site shows the catalog product description (if any) in the
product details section of a listing.
To retrieve a URL for the catalog product details page,
see DetailsURL in FindProducts in the
Shopping API.
Not applicable to Half.com. (For Half.com, use AttributeArray.Attribute with
attributeLabel=“Notes” to specify a brief description or note to the buyer.) -
descriptionReviseMode
This field is applicable if you are modifying the item description. The value
property
selected for this field will determine if the new text entered into the
Item.Description field is added before (Prepend) or after (Append) the
current text in the item description, or if the new text completely replaces the
current text in the item description. -
distance
The distance used in a proximity search distance calculation.
property
Not applicable to Half.com. -
giftIcon
If turned on at listing time, this flag allows the seller to offer one or more gift
services to buyers, and a generic gift icon displays next to the listing’s title in Search
and View Item pages. GiftIcon must be included at listing time and
set to ‘1’ to be able to use one or more GiftServices
options. The value of ‘1’ indicates that this feature is on, and the value of ‘0'
indicates that the feature is off.
Gift Services are only available on the following eBay sites:- Belgium (Dutch)
- Belgium (French)
- France
- Italy
- Netherlands
- Poland
- Spain
property
To verify if Gift Services are enabled for an eBay site, call , call GeteBayDetails
with DetailName set to ListingFeatureDetails.
Then look for GiftIcon=Enabled under the ListingFeatureDetails container in the response.
Not applicable to Half.com. -
giftServices
This field allows the seller to offer optional gift services to the buyer. To offer
one or more gift services to the buyer through an Add/Revise/Relist API call, the seller
must also include the GiftIcon field and set that flag to ‘true’.
Gift Services are only available on the following eBay sites:- Belgium (Dutch)
- Belgium (French)
- France
- Italy
- Netherlands
- Poland
- Spain
property
This field is only returned in GetItem (and other calls that retrieve Item object)
if it is set for the listing.
To verify if Gift Services are enabled for an eBay site, call GeteBayDetails
with DetailName set to ListingFeatureDetails.
Then look for GiftIcon=Enabled under the
ListingFeatureDetails container in the response.
Not applicable to Half.com. -
hitCounter
Indicates whether an optional hit counter is displayed on the item’s listing
property
page and, if so, what type. See HitCounterCodeType for specific values.
Not applicable to Half.com. -
itemID
The ID that uniquely identifies the item listing. The ID is generated
property
by eBay after an item is listed. You cannot choose or revise this
value.
Also applicable to Half.com. For Half.com, you can specify either ItemID or
SellerInventoryID in a ReviseItem request to uniquely identify the
listing.
In order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and
TransactionID to uniquely identify an order line item. With multi-quantity listings, a single ItemID can be associated
with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.)
In GetItemRecommendations, the item ID is required when the value of
ListingFlow is ReviseItem or RelistItem, but it is not applicable when the
value of ListingFlow is AddItem.
Note: Although we represent
item IDs as strings in the schema, we recommend you store them as 64-bit
signed integers. If you choose to store item IDs as strings, allocate at
least 19 characters (assuming decimal digits are used) to hold them. eBay
will increase the size of IDs over time. Your code should be prepared to
handle IDs of up to 19 digits. For more information about item IDs, see <a
href=“http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=468”>Common
FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. -
listingDetails
Various details about a listing, some of which are calculated or
property
derived after the item is listed. These include the start and end
time, converted (localized) prices, and certain flags that indicate
whether the seller specified fields whose values are not visible to
the requesting user. For GetMyeBayBuying, returned as a self-closed
element if no listings meet the request criteria.
Not applicable to Half.com. -
listingDesigner
Contains the detail data for the Listing Designer theme and template (if either
property
are used), which can optionally be used to enhance the appearance of the
description area of an item’s description. See ListingDesignerType for its
child elements.
Not applicable to Half.com. -
listingDuration
Describes the number of days the seller wants the listing to be active (available
property
for bidding/buying). The duration specifies the seller’s initial intent at listing
time. The end time for a listing is calculated by adding the duration to the item's
start time. If the listing ends early, the value of the listing duration does not
change. When a listing’s duration is changed, any related fees (e.g., 10-day fee)
may be debited or credited (as applicable).
The valid choice of values depends on the listing format (see Item.ListingType). For
a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll
and look for ListingDurations information. To set a duration of 1 day, the seller
must have a Feedback score of at least 10.
When you revise a listing, the duration cannot be reduced if it will result in
ending the listing within 24 hours of the current date-time. You are only allowed to
increase the duration of the listing if fewer than 2 hours have passed since you
initially listed the item and the listing has no bids. You can decrease the value of
this field only if the listing has no bids (or no items have sold) and the listing
does not end within 12 hours.
Required for Half.com (but only specify GTC). -
listingEnhancement
This field can be used by the seller to activate one or more listing upgrades for a
property
listing, such as a Bold Title, a Subtitle, or a Value Pack bundle. A ListingEnhancement
field is required for each listing upgrade that the seller wants to activate.
There is a small fee associated with each listing upgrade.
See the
Listing Upgrades help page
for more information on the available listing upgrades.
The listing upgrades that are available vary by site and by the seller’s account
status. To discover which listing upgrades are available, call GeteBayDetails
with DetailName set to ListingFeatureDetails
and pass in the appropriate SiteID value. Then look for the ListingFeatureDetails
container in the response. Listing upgrades will either be listed as ‘Enabled’ or
‘Disabled’.
GetItem (and other calls that retrieve Items) will only return this field if one
or more listing upgrades are set for the listing.
You cannot remove listing upgrades when you revise a listing. When you
relist an item, use DeletedField to remove a listing upgrade.
Not applicable to Half.com. -
listingType
The format of the listing the seller wants to use, such as auction style
property
or fixed price.
Optional for eBay.com listings (defaults to auction style) in AddItem and
VerifyAddItem. Do not specify ListingType for eBay.com listings in
ReviseItem. (You can’t modify the listing type of an active eBay
listing.
Required for Half.com listings (and the value must be Half) in AddItem,
VerifyAddItem, and ReviseItem. If you don’t specify Half when revising
Half.com listings, ReviseItem won’t use the correct logic and you may
get strange errors (or unwanted side effects in the listing, even if no
errors are returned).
-
location
Indicates the geographical location of the item (along with Country).
property
When you revise a listing, you can add or change this value only if the
listing has no bids (or no items have sold) and it does not end within
12 hours.
If you do not specify Location, you must specify Item.PostalCode. If you
specify a postal code, but do not specify a location, then the location is
given a default value derived from the postal code.
For the Classified Ad format for eBay Motors vehicles, the value
provided in the Location is used as item location only if the
SellerContactDetails.Street and the SellerContactDetails.Street2 are empty.
Else, the SellerContactDetails.Street and the SellerContactDetails.Street2
will be used for item location.
Also applicable as input to AddItem and related calls when you list items
to Half.com. -
lotSize
A lot is a set of two or more similar items included in a single listing that must be
property
purchased together in a single order line item. The Item.LotSize value is the number of
items in the lot. This field is required if two or more items are including in one listing.
Lots can be used for auction and fixed price listings. Lot items can be listed
only in lot-enabled categories. Call GetCategories to determine if a category supports
lots. If the returned CategoryArray.Category.LSD (LotSize Disabled) value is true,
the category does not support lots.
Not applicable to Half.com. -
partnerCode
Not currently operational.
property -
partnerName
Not currently operational.
property -
paymentMethods
Identifies the payment method (such as PayPal) that the seller will accept
property
when the buyer pays for the item. For the AddItem family of calls, at least
one payment method is required.
Use GetCategoryFeatures to determine the payment methods that are allowed for a
category on a site. For example, the response data of GetCategoryFeatures will
show that on the US site, most categories only allow electronic payments. Also
use GetCategoryFeatures to determine the default payment method for a site (see
SiteDefaults.PaymentMethod). If a seller does not include at least one payment
method in a Add/Revise/RelistItem API call, the default payment method is used
for the listing.
Do not use GeteBayDetails to determine the payment methods for a site.
For a DE or AT seller’s items that are subject to the new eBay payment process,
only one PaymentMethod field will be returned, and the value
will always be ‘StandardPayment’.
If you specify multiple PaymentMethods fields, the repeating fields must be
contiguous. For example, you can specify PayPalEmailAddress after a list of
repeating PaymentMethods fields, but not between them:
<PaymentMethods>VisaMC</PaymentMethods>
<PaymentMethods>PayPal</PaymentMethods>
<EMAIL_ADDRESS>In general, if you separate repeating instances of a field, the results will
be unpredictable. This rule applies to all repeating fields
(maxOccurs=“unbounded” or greater than 1) in the schema. See “Overview of the
Schema” in the Trading API Guide.
This field is not applicable to eBay Real Estate Ad format,
Classified Ad format, or Half.com listings.
For ReviseItem and RelistItem only:
A listing must have at least one valid payment method.
When you revise or relist an item and you specify a payment method
that is invalid for the target site, eBay ignores the
invalid payment method, applies the other valid
changes, and returns a warning to indicate that the
invalid payment method was ignored. If multiple payment methods were
invalid, the warning indicates that they were all ignored.
If you modify the listing so that it includes no valid
payment methods, an error is returned. This situation could occur when
the seller removes all valid payment methods or when all
the payment methods specified for the item are no longer valid
on the target site. -
payPalEmailAddress
Valid PayPal email address for the PayPal account that the seller will use
property
if they offer PayPal as a payment method for the listing. eBay uses this to
identify the correct PayPal account when the buyer pays via PayPal during
the checkout process. (As a seller can have more than one PayPal account,
you cannot necessarily rely on PayPal account data returned from GetUser for
details about the account associated with the PayPal email address that the
seller specifies.)
Required if seller has chosen PayPal as a payment method (PaymentMethods)
for the listing.
For digital listings, the seller needs to use an email address that is
associated with a PayPal Premier or PayPal business account.
For ReviseItem and RelistItem only: To remove this value
when you revise or relist an item, use DeletedField. When you revise a
listing, if the listing has bids (or items have been sold) or it ends within
12 hours, you can add PayPalEmailAddress, but you cannot remove
it.
Not applicable to eBay Motors listings.
Not applicable to Half.com. -
primaryCategory
Category ID for the first (or only) category in which the item is
listed (or will be listed, if the item is new). A number of listing
features have dependencies on the primary category. We have pointed
out a few of the notable dependencies below. See the descriptions
of the fields you are using to determine whether the feature you're
supporting depends on the listing’s primary category.
For the AddItem family of calls:
Use calls like GetCategories and GetCategoryFeatures to determine valid
values for the site on which you are listing (see the eBay Web Services
Guide for information on working with categories). Also see
Item.CategoryMappingAllowed and
Item.CategoryBasedAttributesPrefill.
There are a number of categories on some eBay sites that always add
the Gallery feature (for free) when you include a picture in
the listing and you don’t specify the Gallery feature yourself.
See GalleryType for information about fees that could be charged
if you change the category in these cases.
Coming soon: If you list with a catalog product, eBay may drop the
primary category you specify and use the category that is associated with the product instead, if different.
Not applicable to Half.com.
For ReviseItem only: When revising a listing,
you can change the primary category only if an item
has no bids (or no items have sold) and the listing does not end
within 12 hours.
If you change the listing category, any Item Specifics (attributes) that
were previously specified may be dropped from the listing if they aren't
valid for the new category. See Item.AttributeSetArray. For the eBay US
site, we suggest that you avoid including a category ID when you list with an external product ID, such as ISBN. See the KB article listed below for details.
You cannot change the meta-categories for vehicles (i.e., you cannot change
a truck to a motorcycle), but you can change the leaf category (e.g., change
one motorcycle subcategory to another motorcycle subcategory). See the eBay
Web Services Guide for additional rules. International sites (such as the
eBay Germany site) have similar rules for revising vehicle categories.
When you list an event ticket on the US site, you must specify the
Event Tickets category as the primary category. Also, when revising
a listing, you cannot change the primary category from another
category to the Event Tickets category. (You need to specify the
Event Tickets category when you initially list the item.)
For GetItemRecommendations only:
For GetItemRecommendations, use this value to control the category that
is searched for recommendations. Specify the category in which
the item will be listed. See <a href=
“http://developer.ebay.com/DevZone/XML/docs/WebHelp/wwhelp/wwhimpl/js/html/wwhelp.htm?context=eBay_XML_API&topic=EngineRecs”
propertyGetting Recommendations to Improve a Listing in the eBay Web
Services guide for differences in validation rules depending on whether
you are using the Listing Analyzer engine, Product Pricing engine,
or Suggested Attribute engine. -
privateListing
The PrivateListing boolean field can be used by the seller in the
property
Add/Relist/Revise family of calls to obscure item title, item ID, and item price from
post-order Feedback comments left by buyers. Typically, it is not advisable that
sellers use the Private Listing feature, but using this feature may be appropriate for
sellers listing in Adults Only categories, or for high-priced and/or celebrity items.
For GetItem, order retrieval calls, and other calls that retrieve
the Item object, the PrivateListing field is only returned if
‘true’.
Not applicable to Half.com. -
productListingDetails
Specifies stock product information to include in a listing.
property
Only applicable when listing items with product details.
See the eBay Trading API Guide
for information on listing with product details.
As ProductID and ProductReferenceID are defined by eBay, they
provide the most reliable means to identify a product.
If you use one of the other industry identifiers (e.g., UPC),
eBay attempts to find a matching product on your behalf and use
it in the listing. If no match is found, you can try using
FindProducts in the Shopping API to determine a ProductReferenceID.
When you specify ProductListingDetails, you must specify at
least one of the available identifiers (e.g., UPC). If you specify
more than one (such as UPC and BrandMPN), eBay uses the first one
that matches a product in eBay’s catalog system. (This may be useful
if you aren’t sure which identifier is more likely to result in a
match.)
When you specify TicketListingDetails, you must specify the
Event Tickets category as the primary category.
For other product identifiers: If you list in two categories and
the primary and secondary categories are both catalog-enabled,
this product identifier should correspond to the primary
category (not the secondary category).
If only one category is catalog-enabled, the product identifier
should correspond to the catalog-enabled category.
(If necessary, use GetCategory2CS to determine which categories are
catalog-enabled.)
Note:
As a general rule, the primary category is required.
However, if you have trouble finding a catalog-enabled
category, you may be able to omit the primary category (except for
event tickets). If you do, eBay will attempt to determine an
appropriate category based on the product ID (if we find a
matching product).
When you specify a category that corresponds to the product
(according to GetCategory2CS), your category is used.
If we don’t find a match in our catalogs,
we will list the item in the primary category you specified,
without product details. We will not pre-fill the listing's
item specifics in this case, and the identifier won’t be surfaced in
View Item or returned in GetItem. However, it will still be indexed
for search on eBay, and it will be searchable by more
third-party natural search engines. As this can help buyers find
your listing more easily, we strongly recommend that you always
use ProductListingDetails to pass in these values.
(This product indexing behavior
is only available if you use UPC, ISBN, EAN, or GTIN in
ProductListingDetails. It is not available if you use
ExternalProductID, and it may not be
available if you exclusively use Item Specifics.)
Either Item.ExternalProductID or Item.ProductListingDetails can be
specified in an AddItem request, but not both.
(ExternalProductID is no longer recommended.)
For ReviseItem and RelistItem only: If a
listing includes product details and you
change a category, the rules for continuing to include product details depend on whether or not the new category is mapped to a
characteristic set associated with the same product ID. When you revise a
listing, if it has bids or it ends within 12 hours, you cannot change the
product ID and you cannot remove existing product data. However, you can
change or add preferences such as IncludeStockPhotoURL,
UseStockPhotoURLAsGallery, and IncludePrefilledItemInformation. To delete all
catalog data when you revise or relist an item, specify
Item.ProductListingDetails in DeletedField and don’t pass
ProductListingDetails in the request.
For GetMyeBayBuying only: When products have been added to a buyer’s Wish List, the product information is returned in ItemArray.Item.ProductListingDetails within the UserDefinedList node. Products can be added to a buyer’s Wish List only. Does not apply to any other user-defined list. The ProductListingDetails node is not included for items in the Wish List.
Not applicable to Half.com. -
quantity
The value indicates the quantity of items available for purchase in the listing.
property
This field is required for all auction listings and for non-variation, fixed-price
listings. For auction listings, this value is always ‘1’. For a non-variation,
fixed-price listing, the Item.Quantity value indicates the
number of identical items the seller has available for purchase in the listing.
For AddFixedPriceItem, VerifyAddFixedPriceItem, RelistFixedPriceItem, and
ReviseFixedPriceItem: in a multi-variation, fixed-price listing, the
Item.Quantity should not be used; instead, the quantity of
each variation is specified in the Variation.Variation.Quantity
field instead. See the Creating a listing with
variations eBay Help page for more information on variations.
For RelistItem and RelistFixedPriceItem:
Like most fields, when you use RelistItem or RelistFixedPriceItem,
Quantity retains its original value unless you specifically change
it. This means that the item is relisted with the value that was
already in Quantity, not with the remaining quantity available.
For example, if the original Quantity value was 10, and 3 items have been sold,
eBay sets the relisted item’s Quantity to 10 by default, and not 7.
So, we strongly recommend that you always
set Quantity to the correct value (your actual quantity available)
in your relist requests.
When eBay auto-renews a GTC listing (ListingDuration=GTC)
on your behalf, eBay relists with correct quantity available.
Note:
There are seller limits on the US site for users who registered after October 2010.
Seller limits control the quantity of items and/or the total value
of the item(s) in the listing. (The GetMyeBaySelling call
returns the remaining item quantity and remaining total value under the limits for
the seller, if any such limits exist for the seller). If a call to add an item or
revise an item would result in the exceeding of these limits, the add item or
revise item call will fail. For auction listings, the total value limit applies to
the start price, not the final sale amount. For more information, see the link to
Seller Limits below.
For GetSellerEvents: Quantity is only returned
for listings where item quantity is greater than 1.
For GetItem and related calls:
This is the total of the number of items available for sale plus the quantity
already sold. To determine the number of items available, subtract
SellingStatus.QuantitySold from this value. Even for items that supported Dutch
auctions, where one of several items can be purchased during the auction, this
number does not change.
For order line item calls with variations:
In GetItemTransactions, Item.Quantity is the same as GetItem (the
total quantity across all variations). In GetSellerTransactions,
Transaction.Item.Quantity is the total quantity of the applicable
variation (quantity available plus quantity sold).
For GetDispute: Quantity is
the number of items being raised in the dispute.
For SetCart input, this is only required if the parent container is submitted.
Also applicable to Half.com (valid range 1 to 1000).
You can revise this field for Half.com listings.
-
privateNotes
A note a user makes on an item in their My eBay account. The note is prefaced with
property
the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not
GetItem) return this field, and only if you pass IncludeNotes in the request. Only
visible to the user who created the note.
Not supported as input in ReviseItem. Use SetUserNotes instead.
For GetMyeBayBuying In WatchList, notes for variations are only
returned at the Item level, not the variation level. They are only set if you
specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are
purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the
site).
In WonList, notes for variations are only returned at the Item level, not the
variation level. They are only set if you specified ItemID and TransactionID in
SetUserNotes (or selected the equivalent in the My eBay UI on the site).
Not applicable to Half.com (instead, use
Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) -
regionID
property -
relistLink
Applicable only to re-listing an item. If true, creates a link in the item's
property
old listing for the item that points to the new relist page, which
accommodates users who might still look for the item under its old item ID.
Not applicable to Half.com. -
reservePrice
The lowest price at which the seller is willing to sell the item. (StartPrice
property
must be lower than ReservePrice.) Not all categories support a reserve price.
See GetCategories and “Determining Whether a Category Supports Reserve Prices"
in the Trading API Guide. In calls that retrieve item data, ReservePrice
only has a non-zero value for listings with a reserve price and where the user
requesting the item data is also the item’s seller. Not applicable to fixed-
price items or ad format listings.
You can remove the reserve price of a US eBay Motors listing if the category allows
it, the current reserve price has not been met, and the reserve price is at least
$2.00 more than the current high bid. In this case, if the item has bids, the reserve
price is set to $1.00 over the current high bid. The next bid meets the reserve and
wins. See the Fees Overview on the eBay Web site for information about fee credits
that may be available when the reserve price is removed for a Motors listing. See the
Trading API Guide for validation rules when revising US Motors
listings.
The relisted item cannot have a reserve price if the original listing didn’t have one. If
the original listing had a reserve price, the relisted item’s reserve price can’t be
greater than that of the original listing.
Not applicable to Half.com. -
reviseStatus
An output value only, indicates whether an item has been revised
property
since the listing became active and, if so, which among a subset of
properties have been changed by the revision.
Not applicable to Half.com. -
scheduleTime
Allows the user to specify the time that the listing becomes active on eBay.
To schedule the listing start time, specify a time in the future in GMT
format. In GetItem and related calls, the scheduled time is returned in
StartTime. For ReviseItem, you can modify this value if the currently
scheduled start time is in the future.
When you schedule a start time, the start time is randomized within 15-minute
intervals. Randomized start times applies to the following sites:
AT, BEFR, BENL, CH, DE, ES, FR, IE, IT, NL, PL, UK
Also see the following article in the Knowledge Base: <a href=
“http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1473”
propertyWhy scheduled time is sometimes getting reset.
Not applicable to Half.com. -
secondaryCategory
ID for second category in which the item is listed (also see
Item.PrimaryCategory).
For the AddItem family of calls: Listing an item in
a second category is optional. Also see Item.CategoryMappingAllowed
and Item.CategoryBasedAttributesPrefill.
Not applicable to Half.com.
On the eBay UK, Ireland, Germany, Austria, Switzerland, and Italy
sites you can list Store Inventory listings in two categories.
On the eBay US and other sites, you cannot list Store Inventory
listings in two categories.
You cannot list US eBay Motors vehicles in two categories. However, you can
list Parts & Accessories in two categories. The Final Value Fee is based
on the primary category in which the item is listed. Furthermore, you can
list the same item in an eBay Motors Parts & Accessories category and in
an eligible eBay category, as long as the primary category is associated
with the site on which you are listing. That is, the two categories can be a
mix of Motors Parts & Accessories and eBay site categories. (Real
Estate, Mature Audience (adult), and Business & Industrial categories
are not eligible for listing in two categories in this manner.) For example,
if you list on Motors, the primary category could be 6750 (eBay Motors >
Parts & Accessories > Apparel & Merchandise > Motorcycle >
Jackets & Leathers), and the secondary category could be 57988 (eBay
propertyClothing, Shoes > Accessories > Men’s Clothing > Outerwear).
If you list on the main eBay site, the primary category could be 57988 and
the secondary category could be 6750.
If eBay has designated a category as a value category -
freeAddedCategory
ID for a second category that eBay added as a free promotion. You cannot add
property
this yourself. Only returned if the item was listed in a single category and
eBay added a free second category.
Not applicable to Half.com. -
seller
Container for information about this listing’s seller.
property
Not applicable to Half.com.
Returned by GetItemsAwaitingFeedback if Buyer is making the request. -
sellingStatus
Various details about the current status of the listing, such as the current
property
number of bids and the current high bidder.
Not applicable to Half.com. -
shippingDetails
The shipping-related details for an order, including flat and
property
calculated shipping costs and shipping insurance costs.
New users who list their first items in selected categories on the US site
must specify at least one domestic shipping service. This applies to a
category if GetCategoryFeatures returns true for
Category.ShippingTermsRequired.
For multiquantity Store Inventory Format listings and for multiquantity
Fixed Price listings, a seller can revise all shipping details of the
listing (except for sales tax and for shipping type of Freight) for all
unsold items. This applies to both domestic and international shipping.
Checkout is not affected for those who bought items prior to the seller's
shipping changes–the shipping details that were in effect at the time of
purchase are used for that buyer at the time of checkout.
IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing.
Shipping details are not applicable to Real Estate listings and Half.com.
GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned
(with a request version 677 or higher) if (a) the item is marked as
local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a
request version lower than 677, ShippingDetails is returned.) -
shipToLocations
An international location or region to which the seller is willing to ship,
property
regardless of shipping service. The country of the listing site is added by
eBay. Use GeteBayDetails
with DetailName set to ShippingLocationDetails
to determine which international locations are valid for the site. In the
GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields.
Omit ShipToLocations if you want to ship only within the country of the listing site.
To state that you do not wish to ship at all, set ShipToLocations to None.
ReviseItem can add a ShipToLocations. On output, ShipToLocations is the
collection of all input item-level ShipToLocations plus international shipping
service-level ShipToLocation values.
If you have specified a region to which you will ship (such as Asia), you can
use ExcludeShipToLocation to exclude certain countries within that region to
where you will not ship (such as Afghanistan).
Not applicable to Half.com. -
site
The name of the site on which the item is listed. The listing site affects
property
the business logic and validation rules that are applied to the request,
which in turn affect the values that are returned in the response, as well
as values that appear on the eBay Web site. For example, the listing site
can affect the validation of Category in listing requests, international
business seller requirements, the values of converted (localized) prices in
responses, the item-related time stamps that are displayed on the eBay Web
site, the visibility of the item in some types of searches, and other
information. In some cases, the rules are determined by a combination of
the site, the user’s registration address, and other information. You
cannot change the site when you revise a listing.
When you specify Item.Site in AddItem or AddFixedPriceItem, it must be consistent with the
numeric site ID that you specify in the request URL (for the SOAP API) or
the X-EBAY- API-SITEID header (for the XML API).
Not applicable to Half.com. -
startPrice
This value indicates the starting price of the item when it is listed for the
property
first time, or when it is revised or relisted.
For auction listings: competitive bidding starts at this
value. Once at least one bid has been placed, StartPrice remains the same but
CurrentPrice is increased to the amount of the current highest bid. If ReservePrice
is also specified, the value of StartPrice must be lower than the value of
ReservePrice.
For fixed-price listings:
This is the fixed-price at which a buyer may purchase the item.
Note:
There are seller limits on the US site for users who registered after October 2010.
Seller limits control the quantity of items and/or the total value
of the item(s) in the listing. (The GetMyeBaySelling call
returns the remaining item quantity and remaining total value under the limits for
the seller, if any such limits exist for the seller). If a call to add an item or
revise an item would result in the exceeding of these limits, the add item or
revise item call will fail. For auction listings, the total value limit applies to
the start price, not the final sale amount. For more information, see the link to
Seller Limits below.
GetMyeBaySelling does not return Item.StartPrice
for fixed price items–it returns Item.SellingStatus.CurrentPrice.
For AddFixedPriceItem and VerifyAddFixedPriceItem:
Required when no variations are specified. If variations are specified,
use Variation.StartPrice for each variation instead.
Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise
this field for Half.com listings. -
storefront
Contains information related to the item in the context of a seller’s eBay
property
Store. Applicable for auction and fixed-price listings listed by eBay Stores sellers.
Not applicable to Half.com. -
subTitle
Subtitle to use in addition to the title. Provides more keywords when buyers
property
search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML
characters will be interpreted literally as plain text.) If you pass any
value, this feature is applied (with applicable fees).
Not applicable to listings in US eBay Motors passenger vehicle, motorcycle,
and “other vehicle” categories or to listings in CA eBay Motors passenger
vehicle and motorcycle categories. For eBay Motors categories that do
not support this field, use Item Specifics (AttributeSetArray) to specify the
vehicle subtitle.
When you revise a item, you can add, change, or remove the
subtitle.
Not applicable to Half.com. -
timeLeft
Time left before the listing ends.
property
The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS).
See Data Types in the Trading API Guide for information about this format.
For ended listings, the time left is PT0S (zero seconds).
Not applicable to Half.com. -
title
Name of the item as it appears in the listing or search results. Title is
property
required for most items. This field is only optional if you leverage Pre-filled
Item Information by using the Item.ProductListingDetails or
Item.ExternalProductID containers.
You cannot use HTML or JavaScript in the Title.
(HTML characters will be
interpreted literally as plain text.)
For the AddItem family of calls: Not applicable to Half.com.
For ReviseItem and ReviseFixedPriceItem
You can only add or change the item title if the listing has no
bids (for auctions) or sales (for fixed-price listings) and
the listing does not end within 12 hours.
For GetItemRecommendations: More keywords in the
title usually result in more relevant Listing Analyzer
recommendations. -
uuid
Universally unique constraint tag. Use UUID to ensure that you only list a
property
particular item once, particularly if you are listing many items at once. If
you add an item and do not get a response, resend the request with the same
UUID. If the item was successfully listed the first time, you will receive
an error message for trying to use a UUID that you have already used. The
error will also include the item ID for the duplicated item and a boolean
value indicating whether the duplicate UUID was sent by the same application.
We recommend you use Item.UUID with calls that add item objects (for example, AddItem
and RelistItem). For calls that modify an existing item, such as ReviseItem, use
InvocationID instead.
The UUID can only contain digits from 0-9 and letters from A-F and must be
32 characters long. The UUID value must be unique across all item listings
on all sites.
Also applicable as input to AddItem and related calls when you list
items to Half.com. -
vatDetails
Container for eBay’s VAT features. A business seller can choose to
property
offer an item exclusively to bidders and buyers that also represent businesses.
Only applicable when the item is listed in a B2B-enabled category (on a site
that supports B2B business features).
Note:
The India site (Global ID 203) does not accept VAT values in item listings. If you
submit an item to the India site with a VAT value, eBay generates a warning message
that indicates the listing was accepted, but the VAT value was removed. To include
the VAT, relist the item with a Price value that includes the VAT. Sellers are
solely responsible for compliance relating to tax legislation in India.
Not applicable to Half.com. -
sellerVacationNote
The seller is on vacation (as determined by the seller’s store preferences) in
property
two cases: i.) the item is a Store Inventory item and the seller has chosen to
hide Store Inventory items while on vacation, and ii.) the seller has chosen
to add a message to listed items while on vacation.
Not applicable to Half.com. -
watchCount
The number of watches placed on this item from buyers' My eBay accounts.
property
Specify IncludeWatchCount as true in the request.
Returned by GetMyeBaySelling only if greater than 0.
Not applicable to Half.com. -
hitCount
The number of page views for the item. This number is calculated by eBay and
property
cannot be set via the API. Returned if the hit counter type is BasicStyle,
RetroStyle, or HiddenStyle. For HiddenStyle, HitCount is returned only if the
requestor is the item’s seller. -
disableBuyerRequirements
If true: all buyer requirements (from Item.BuyerRequirementDetails
property
or Buyer requirements preferences in My eBay) are ignored.
If false (or omitted): Item.BuyerRequirementDetails or Buyer
requirements preferences are used, with Item.BuyerRequirementDetails
having the higher precedence. -
bestOfferDetails
Container for BestOffer properties associated with the item.
property
Not applicable to Half.com. -
locationDefaulted
True if eBay provided a central location as a result of the user
property
not specifying a location. This typically occurs when the seller
specifies PostalCode without Location.
Not applicable to Half.com. -
thirdPartyCheckout
As of July 1, 2011, third-party applications can no longer be used for
property
checkout. All purchased items must go through the eBay Checkout flow.
This field can no longer be passed into the Add Item family of calls.
This field will be returned in some calls (that return the Item container) if
it was set to True at listing time (for listings created before July 1, 2011).
If this field was set to True at listing time, the user must include this field
and set it to False in the Relist and Revise Item family of calls. Otherwise,
the caller may get an error. -
useTaxTable
Indicates whether the seller’s tax table is to be used when applying and
property
calculating sales tax for an order line item. A sales tax table can be
created programmatically using the SetTaxTable call, or it can be created
manually in My eBay’s Selling Preferences. If UseTaxTable is set to true,
the values contained in the seller’s sales tax table will supersede the
values contained in the Item.ShippingDetails.SalesTax container (if
included in the request).
Not applicable to Half.com. -
getItFast
Indicates whether the seller has committed to the GetItFast
property
shipping rules for this listing. If the GetItFast field is set
to true, and the seller’s first priority domestic shipping
service (the service that has the ShippingServicePriority
field set to 1) is an expedited shipping service, then every
shipping service offered for this listing is considered a GetItFast
service. Therefore, the seller commits to delivering the item to
the buyer-selected shipping service within one day.
Not supported for UK Store Inventory format items.
Not applicable to Half.com. -
buyerResponsibleForShipping
Applicable for listings in vehicle categories on the US eBay Motors site and
property
eBay Canada site. (No business effect if specified for other categories or
sites, as the Web site will not display the information to buyers.) If true,
the buyer is responsible for vehicle pickup or shipping. If false, specify
vehicle shipping arrangements in the item description. Default is true. (The
description can also include vehicle shipping arrangements when this value is
true.) If the item has bids or ends within 12 hours, you cannot modify this
flag. Do not specify ShippingDetails.ShippingServiceOptions
for vehicle listings.
If true and the listing is on the US eBay Motors site, and you want the
listing to be visible on the eBay Canada site, set Item.ShipToLocations to CA.
If true and the listing is on the eBay Canada site , and you want your listing
to be visible on the US eBay Motors site, set Item.ShipToLocations to US.
Not applicable to Half.com. -
limitedWarrantyEligible
This feature is no longer supported. This field will be removed
property
from the schema in an upcoming release.
Applicable to US eBay Motors vehicle listings
only. If false, the vehicle was not considered for a
limited warranty by eBay. If your application lists
Motors vehicles, you were required to provide the seller with an opportunity to indicate
whether the vehicle has not been modified and is not a special type (e.g.,
Corvette ZR1). If LimitedWarrantyEligible was passed in, it meant the
application presented the seller with checkboxes to indicate this
information. If true, the seller verified that the vehicle has not been
modified and is not a special type. If false, the seller verified that
vehicle has been modified or it is a special type. Passing a value of true
did not guarantee that eBay would offer a limited warranty. It only made the
listing eligible for consideration.
Not applicable to Half.com. -
eBayNotes
Returns a note from eBay displayed below items in the user’s My
property
eBay account.
Not applicable to Half.com. -
questionCount
Specifies the number of questions buyers have posted about the
property
item. Returned only if greater than 0.
Not applicable to Half.com. -
relisted
Whether or not the item is a relisted item. This value is
property
determined by eBay and cannot be set. Only returned if the
item was relisted.
Note that when an item is relisted and is given a new
ItemID, the original item shows Relisted = true, but the new
item does NOT show Relisted = true. In this context, the new
item is a new listing, not a “Relisted” one. -
quantityAvailable
Specifies how many of a certain item are available.
property
Not applicable to Half.com. -
sku
A SKU (stock keeping unit) is an identifier defined by a seller.
property
Some sellers use SKUs to track complex flows of products
and information on the client side.
A seller can specify a SKU when listing an item with AddItem
and related calls. eBay preserves the SKU on the item, enabling you
to obtain it before and after an order line item is created.
(SKU is recommended as an alternative to ApplicationData.)
A SKU is not required to be unique, when you track listings by
their ItemID (the default tracking method). A seller can specify a
particular SKU on one item or on multiple items.
Different sellers can use the same SKUs.
If you want to use SKU instead of ItemID as a unique identifier
(such as when retrieving items and orders), you can set
Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and
related calls. In this case, the SKU must be
unique across your (the seller’s) active listings.
Note that if you relist the item, you must reset
Item.InventoryTrackingMethod to SKU; otherwise the relisted
item will default to ItemID as the tracking method.
If both ItemID and SKU are specified in item-retrieval and
order-retrieval calls that support the use of SKU as a unique
identifier, the ItemID value takes precedence and is used to
identify the listing.
For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted.
If InventoryTrackingMethod is ItemID, an ItemID is also required.
When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier.
Note:
The eBay Web site UI cannot identify listings by SKU. For example,
My eBay pages and Search pages all identify listings by item ID.
When a buyer contacts you via eBay’s messaging functionality, eBay
uses the item ID as the identifier. Buyer-focused APIs (like the
Shopping API) also do not support SKU as an identifier.
For revising and relisting only:
To remove a SKU when you revise or relist an item, use DeletedField.
(You cannot remove a SKU when Item.InventoryTrackingMethod is set
to SKU.)
For GetMyeBaySelling, this is only returned if set.
Not applicable to Half.com. -
categoryBasedAttributesPrefill
Allows eBay to auto-fill some of a listing’s Item Specifics (attribute) values
property
based on the listing’s category (or categories). Auto-filling attributes based
on a category is not the same as using Pre-filled Item Information based on a
catalog product (see ProductListingDetails). If true, also specify
Item.CategoryMappingAllowed with a value of true. See the Trading API Guide for more information.
Ignored if the category does not support auto-filling attributes.
If you also pass in attributes in AttributeSetArray, your values will override
any auto-filled values for the same attributes. Once you have overridden the
value of an auto-filled attribute for a given listing, eBay will not auto-fill
it on subsequent ReviseItem requests (even if you remove the overridden
value).
Not applicable to Half.com. -
searchDetails
Container for values that indicate whether a listing uses the Buy It Now feature,
property
whether a listing is no more than one day old, and whether a listing has an image
associated with it.
Not applicable to Half.com. -
postalCode
Postal code of the place where the item is located. This value is used for
property
proximity searches. To remove this value when revising or relisting an item,
use DeletedField. If you do not specify PostalCode, you must specify
Item.Location. If you specify PostalCode, but do not specify Item.Location,
then Item.Location is given a default value derived from the postal code.
Not applicable to Half.com. -
shippingTermsInDescription
Indicates whether details about shipping costs and arrangements are
property
specified in the item description.
Not applicable to Half.com. -
externalProductID
This field will be removed in a future release.
property
New applications should use ProductListingDetails instead. -
sellerInventoryID
Unique identifier for a Half.com item. Must be an alphanumeric value (with no
property
symbols) that is unique across the seller’s active (unsold) inventory on
Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in
a ReviseItem request to uniquely identify the listing. Only returned from
GetOrders if the seller specified a value when the item was listed. You cannot
revise this field.
Not applicable to eBay.com listings. -
pictureDetails
Contains the data for a picture associated with an item. With the exception of
property
eBay Motors vehicle listings, you can add up to 12 standard pictures free of
charge.
Note:
As of October 1, 2012, all listings must have at least one picture.
Not applicable to Half.com. -
dispatchTimeMax
Specifies the maximum number of business days the seller
property
commits to for preparing an item to be shipped after receiving a
cleared payment. This time does not include the shipping time (the carrier’s transit time).
For the AddItem family of calls: Required for
listings in certain categories when certain shipping services
(with delivery) are offered. See HandlingTimeEnabled in
GetCategoryFeatures.
The seller sets this to a positive integer value corresponding to the number of days. For a list of allowed values on each eBay site, use GeteBayDetails with DetailName set to DispatchTimeMaxDetails. (Typical values are 1, 2, 3, 4, 5, 10, 15, or 20, but this can vary by site and these may change over 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. For example, when ShippingService=Pickup or ShipToLocations=None, then DispatchTimeMax is not required.
Note: A dispatch time value of ‘0
’ is not valid for use on eBay sites. With Add, Relist, Revise and Verify calls, if you wish to indicate that a listing with flat or calculated shipping has no handling time commitment, submit Item.DispatchTimeMax as an empty field.
To add Get It Fast to listings (for domestic shipping), in addition to setting GetItFast to true,
DispatchTimeMax must be set to 1 and the seller must specify at least
one qualifying expedited shipping service.
Note:
To receive a Top-Rated Plus seal for their listing, Top-Rated Sellers must offer 1-day handling (DispatchTimeMax=1)
and accept returns (ReturnPolicy.ReturnsAcceptedOption=ReturnsAccepted).
Top-Rated listings qualify for the greatest average boost in Best
Match and the 20 percent Final Value Fee discount. For more information on changes to eBay's
Top-rated seller program, see the 2012 Fall Seller Update page.
For ReviseItem only:
If the listing has bids or sales and it ends within 12 hours, you can’t change this value.
If the listing is a GTC listing that has sales or ends within 12 hours
(one or the other, but not both), you can add or change this value.
If the listing has no bids or sales and more than 12 hours remain before
the listing ends, you can add or change the dispatch (handling) time.
For GetItem: GetItem returns DispatchTimeMax
only when shipping service options are specified for the item and
the seller specified a dispatch time. -
skypeEnabled
Specifies that Skype-related information is included with an item listing,
property
including, for example, Skype Voice. Skype-related information provides
buttons that enable potential buyers to contact sellers through Skype.
Information about Skype is available at www.Skype.com. If all of the
prerequisites for adding Skype buttons to listings are met (see the eBay Web
Services Guide), you can make communication through Skype available in
listings. SkypeEnabled must be true if SkypeID and SkypeContactOption are
specified. -
skypeID
The Skype name of the seller. Requires that SkypeEnabled is set to true.
property
Available if the seller has a Skype account and has linked it (on the eBay
site) with his or her eBay account. -
skypeContactOption
Indicates the Skype contact option that the seller and buyer can use to communicate
property
about the listing. For Skype communication to be possible, the
SkypeEnabled flag must be included and set to ‘true’.
The seller must also have a Skype account that is linked with his or her eBay
account.
More than one Skype contact option may be specified. -
bestOfferEnabled
Indicates, when true, that an item is available by Best Offer.
property -
localListing
Indicates, when true, that an item is available locally.
property -
thirdPartyCheckoutIntegration
As of July 1, 2011, third-party applications can no longer be used for
property
checkout. All purchased items must go through the eBay Checkout flow.
This field can no longer be passed into the Add Item family of calls.
This field will be returned in some calls (that return the Item container) if
it was set to True at listing time (for listings created before July 1, 2011).
If this field was set to True at listing time, the user must include this field
and set it to False in the Relist and Revise Item family of calls. Otherwise,
the caller may get an error.
Be aware that you may need to use SetNotificationPreferences
to change the ApplicationURL value if you were formerly
having Checkout notifications sent to your third-party checkout application.
-
listingCheckoutRedirectPreference
Container consisting of the ProStores store name and user name.
property -
sellerContactDetails
Contact information for sellers using the Classified Ad format for eBay
property
Motors vehicles categories. To remove seller contact information when
revising or relisting an item, use DeletedField. The seller contact details
for the primary and secondary phone numbers cannot be deleted
individually.
To provide City, State, and Zip code information in
SellerContactDetails use the following field:
Item.SellerContactDetails.Street2
To delete the secondary phone number, for example, you must delete all of
the secondary phone fields:
Item.SellerContactDetails.Phone2AreaOrCityCode
Item.SellerContactDetails.Phone2CountryCode
Item.SellerContactDetails.Phone2CountryPrefix
Item.SellerContactDetails.Phone2LocalNumber -
totalQuestionCount
The number of questions asked about this item. Applies to eBay Motors Pro
property
applications only. -
proxyItem
Some listings on the eBay platform originate from eBay affiliates.
property
Depending on the relationship the affiliate has with eBay, there are times
when the affiliate retains ownership of the listing. When this occurs
the representation of the listing on eBay is considered a proxy item. Proxy
items can only be edited using API requests from the applications that
originally listed them. -
extendedSellerContactDetails
Extended contact information for sellers using the Classified Ad format.
property
Specifies the days and hours when the seller can be contacted.
To remove seller contact information when revising or relisting an item, use
DeletedField. -
leadCount
Specifies the number of leads (emails) buyers have posted about the item.
property
You must be the seller of the item to retrieve the lead count. -
newLeadCount
Specifies the number of new leads (unanswered emails) buyers have posted
property
about the item. -
itemSpecifics
A list of Item Specific name and value pairs that the
property
seller specified for the item.
Item Specifics describe well-known aspects of an
item or product in a standard way, to help buyers find that
type of item or product more easily.
or example, “Publication Year” is a typical aspect of books,
and “Megapixels” is a typical aspect of digital cameras.
In the AddItem family of calls, use Item.ItemSpecifics to specify
custom Item Specifics.
To determine which categories support custom Item Specifics, use
GetCategoryFeatures.
To retrieve recommended Item Specifics, use GetCategorySpecifics.
With GetItem, this is only returned when you specify
IncludeItemSpecifics in the request (and the seller included
custom Item Specifics in their listing).
For ReviseItem only: When you revise a listing,
if the listing has bids and ends within 12 hours, you cannot change or
add Item Specifics. If the listing has bids but ends in more
than 12 hours, you cannot change existing Item Specifics, but you can
add Item Specifics that were not previously specified.
To delete all Item Specifics when you revise or relist, specify
Item.ItemSpecifics in DeletedField and don’t pass ItemSpecifics in the
request.
Note:
To specify an item’s condition, use the ConditionID field
instead of a condition item specific.
Use GetCategoryFeatures to see which categories support
ConditionID and to get a list of valid condition IDs.
(If you specify ConditionID and you also specify
Condition as a custom item specific, eBay drops the condition
item specific.)
-
groupCategoryID
GroupCategoryID is returned if there is a value of
property
BestMatchCategoryGroup in the Order field for the GetSearchResults
call. However, the results depend on the items and groups
requested.
The Best Match algorithm will try to evenly fit the items and
return groups of ‘Best Matching’ Categories. A ‘category group’ can
be a parent category that contains the best-matching items from
several of its subcategories. Within each category group, items
will be also sorted by best match. The only condition when you may
not get a GroupCategoryID returned at all is when the request is
for one group and there is more than one category that has matching
items. Very rarely, the same item will appear once in the group for
its primary category and once in another group for its secondary
category, in the same result set. Also very occasionally, a Store
Inventory Item can appear in the results before a regular listing. -
classifiedAdPayPerLeadFee
The pay-per-lead feature is no longer available, and this field is scheduled to
property
be removed from the WSDL. -
bidGroupItem
This flag is set to true if a watched item belongs to a bid
property
group. It will only be returned for the Watch container. -
applyBuyerProtection
Container consisting of details related to whether or not the
property
item is eligible for buyer protection and which of the buyer protection
programs will cover the item. This container is not returned if the item is not
eligible for eBay or PayPal buyer protection. -
listingSubtype2
Indicates a specific type of lead generation format listing, such as
property
classified ad or local market Best Offer listing. Only applicable when
ListingType=LeadGeneration.
Note:
ListingSubtype2 replaces the deprecated ListingSubtype field.
If both are specified in a request, ListingSubtype2 takes precedence.
-
mechanicalCheckAccepted
Indicates whether the seller allows the bidder to request mechanical
property
inspection services from RAC. For Car category listings on the UK site. -
updateSellerInfo
Specifies whether the following Business Seller fields have been updated for
property
the item specified in the request: First Name, Last Name, Fax, Email
Address, Additional Contact Information, Trade Registration Number, VAT
Identification Number. -
updateReturnPolicy
Flag to indicate whether the item’s Return Policy has been updated
property
as part of the revised listing. -
itemPolicyViolation
Specifies the details of policy violations if the item was administratively
property
canceled. -
crossBorderTrade
This field is used by sellers who want their listing to be returned in the search
property
results for other eBay sites. This feature is currently only supported by the US, UK,
eBay Canada, and eBay Ireland sites. See Getting exposure on
international sites for full requirements on using this feature. There is a
small listing fee for each country specified as a Cross Border Trade country.
US listings that offer shipping to Canada, North America, or worldwide are
automatically returned on eBay.ca at no extra charge, so US listings that offer
shipping to these locations do not need to specify Canada as a Cross Border Trade
country. -
businessSellerDetails
Returns the seller’s information (in a business card format)
property
if the seller’s SellerBusinessCodeType is set to ‘Commercial’.
This is only applicable for sites where Business Seller options
are supported. -
buyerGuaranteePrice
For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection
property
coverage, offered for the item at the time of purchase. Details of coverage
are in the following sections of the View Item page: the Buy Safely section
and the Payment Details section. -
buyerRequirementDetails
When this container is present in an AddItem or AddFixedPriceItem call, all
property
buyer requirements for the resulting listing are set by this container.
Furthermore, individual buyer requirements cannot be modified or added when
including this container in a ReviseItem call. The ReviseItem call needs to
provide the entire set of buyer requirements to modify or add any of the
requirements. Unless otherwise specified, most buyer requirements are only
returned if the caller is the seller. All global My eBay Buyer Requirements
are overridden by the contents of this container. This means that buyer
requirements set in My eBay cannot be combined with buyer requirements
included in this container.
Not applicable to Half.com. -
returnPolicy
Container that describes the seller’s return policy. Most categories on most
property
eBay sites require the seller to include a return policy through the
ReturnPolicy container.
For the AddItem family of calls: Required for
most categories on most sites. Use ReturnPolicyEnabled
in GetCategoryFeatures to determine which categories require this
field. To determine which ReturnPolicy fields can be used on each site, call GeteBayDetails
with DetailName set to ReturnPolicyDetails.
eBay India (IN), Australia (AU), and US eBay Motors
Parts and Accessories categories typically support but do not
require a return policy. (However, we strongly recommend that
you specify a clear return policy whenever possible.)
For ReviseItem only: If the listing has bids or
sales and it ends within 12 hours, you can’t change the return policy
details. If the listing is a GTC listing that has sales or ends within 12
hours (one or the other, but not both), you can add a return policy to the
GTC listing (but you can’t change return policy details if already present).
If the listing has no bids or sales and more than 12 hours remain before the
listing ends, you can add or change the return policy. When you revise your
return policy, you only need to specify the fields you want to add or
change. You don’t need to specify all the other ReturnPolicy fields again.
The other fields will retain their existing settings.
For the GetItem family of calls: Only returned if the
site you sent the request to supports the seller’s return policy. Typically,
the return policy details are only returned when the request is sent to the
listing site. -
paymentAllowedSite
Enables you to view the sites on which an item can be purchased,
property
based on the payment methods offered for the item. -
inventoryTrackingMethod
Indicates whether you prefer to track your eBay listings by
property
eBay Item ID or by your own SKU.
If you want to use SKU instead of ItemID as a unique identifier
(such as when retrieving items and orders), you can set
Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and
related calls. In this case, the SKU must be
unique across your (the seller’s) active listings.
Note that if you relist the item, you must reset
Item.InventoryTrackingMethod to SKU; otherwise the relisted
item will default to ItemID as the tracking method.
If both ItemID and SKU are specified in item-retrieval and
order-retrieval calls that support the use of SKU as a unique
identifier, the ItemID value takes precedence and is used to
identify the listing.
For GetItem and related calls:
Only returned when the value is SKU; not returned when the value is ItemID.
Not applicable to Half.com. -
integratedMerchantCreditCardEnabled
Indicates whether the item can be paid for through a payment gateway
property
(Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then
integrated merchant credit card (IMCC) is enabled for credit cards because
the seller has a payment gateway account. Therefore, if
IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC
is returned for an item, then on checkout, an online credit-card payment is
processed through a payment gateway account. A payment gateway account is
used by sellers to accept online credit cards (Visa, MasterCard, American
Express, and Discover). -
variations
Variations are multiple similar (but not identical) items in a
property
single fixed-price listing. For example, a T-shirt listing
could contain multiple items of the same brand
that vary by color and size (like “Blue, Large” and
“Black, Medium”). Each variation specifies a combination of one of
these colors and sizes. Each variation can have a different
quantity and price. You can buy multiple items from one
variation at the same time. (That is, one order line item can contain
multiple items from a single variation.)
If you list in two categories, both categories must support
listing with variations. See VariationsEnabled in
GetCategoryFeatures to determine applicable categories.
For ReviseFixedPriceItem and
RelistFixedPriceItem: Once a listing has been submitted with variations,
you can’t delete all the variations when you revise or relist the listing (because
it would be considered a different listing). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has
no purchases, use the Variation.Delete field to delete the variation. If it has
inventory, set the Quantity to 0.
As a best practice, if you want to revise multiple variations in
the same listing at the same time (i.e, within a very short period),
use a single ReviseFixedPriceItem request and include all the
variation revisions in the same request. If your application design
requires you to revise each variation individually, then avoid using
multiple parallel threads. Instead, use a serial, synchronous
process. That is, wait until each revision has been
processed by eBay before submitting the next revision request for
another variation in the same listing.
For GetItem and related calls Only returned
when a listing has variations.
For GetSellerList: Only returned when a listing
has variations, IncludeVariations was set to true in the request,
the DetailLevel was set to ReturnAll, and an applicable pagination
value and time range were specified.
For GetItemTransactions Only returned in Item
when a listing has variations and IncludeVariations was set to true
in the request. (Also see Variation returned in Transaction for
information about which variation was actually purchased.)
For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling: Only returned
when a listing has variations and HideVariations was set to false
or not specified in the request. -
itemCompatibilityList
A list of parts compatibility information specified as name and value pairs.
property
Describes an assembly with which a part is compatible (i.e., compatibility by
application). For example, to specify a part’s compatibility with a vehicle,
the name (search name) would map to standard vehicle characteristics (e.g.,
Year, Make, Model, Trim, and Engine). The values would desribe the specific
vehicle, such as a 2006 Honda Accord. Use the Product Metadata API to
retrieve valid search names and corresponding values.
For the AddItem family of calls: Use this for specifying
parts compatibility by application manually. This can only be used in
categories that support parts compatibility by application. Use <b
class=“con”>GetCategoryFeatures with the “CompatibilityEnabled"
feature ID to determine which categories support parts compatibility by
application.
Note:
Starting with release 687, invalid item compatibility combinations will not
cause the request to fail as long as <b
class="con”>ItemCompatibilityList contains at least one valid
item compatibility. Only valid compatibilities will be added to the listing.
Any invalid compatibility combinations will be reported in the long error
message in the response errors with a severity of Warning.
For ReviseFixedPriceItem and ReviseItem: When you revise a
listing, if the listing has bids and/or ends within 12 hours, item
compatibilities cannot be deleted. You may add item compatibilities at any
time.
For GetItem: <b
class=“con”>ItemCompatibilityList is only returned if the
seller included item compatibility in the listing and <b
class=“con”>IncludeItemCompatibilityList is set to true in the
GetItem request. -
itemCompatibilityCount
Indicates the number of compatible applications specified for the given item.
property
Applies to items listed with fitment by application only (either manually or
with a catalog product that supports compatibility).
Not returned if the item has no specified compatible applications. Not
returned if IncludeItemCompatibilityList is
specified in the request.
To retrieve the list of compatibility information, set
IncludeItemCompatibilityList to “true” in the request. -
conditionID
The numeric ID (e.g., 1000) for the item condition.
property
Sellers should also clarify the item’s condition in their
own item description.
Note:
In addition to including notes on flaws or wear and tear on an used item in the
Item.Description, and including a ConditionID
value, you can provide additional information about the condition of your used item
through the Item.ConditionDescription string field.
For the AddItem family of calls:
Use GetCategoryFeatures for details about which categories support
(or require) ConditionID, plus policies and help on choosing the
right condition for the item (to reduce disputes).
Please note the following behavior if you pass a ConditionID value
that is not valid for the category: If ConditionID is disabled
(or not applicable) for the category, the item is listed with no
condition. If ConditionID is enabled or required for the category, the listing
request fails.
If you are listing in two categories, the primary category determines which
condition model (ConditionID or item specifics) and which condition values
can be used.
US eBay Motors Parts & Accessories and vehicle categories require ConditionID for new
listings and re-listings.
Not applicable to Half.com in listing requests (e.g., AddItem).
However, ConditionID could be returned in responses for
Half.com listings that are available to or sold on the
eBay site (as appropriate for the corresponding eBay category).
For Revise/Relist calls: In most cases, you can add or modify
ConditionID when you revise or relist.
If GetCategoryFeatures returns ConditionEnabled=Required for the
listing’s category, you cannot remove ConditionID from the listing.
If an auction has bids or ends within 12 hours, you cannot remove or
change its condition, and you cannot replace a condition
attribute or custom item specific with ConditionID. In this case,
you will still be able to modify other fields that are normally
editable, even if ConditionID is not present.
In most cases, you can add or modify ConditionID for multiquantity
fixed price listings. (If a multiquantity fixed price listing has
revision restrictions imposed by other choices the seller has made
in the listing, you might not be able to remove or change the
condition.)
If you revise or relist a GTC listing that only has a condition
attribute or custom item specific, you need to specify ConditionID
(if the category requires it). ReviseInventoryStatus also fails
if you attempt to revise listings that are missing ConditionID.
(This rule does not apply during auto-renewal of a GTC listing.
It only applies when you perform an action on the listing.)
For GetItem and GetSellerList: Only returned when the seller
specified ConditionID in their listing. Also returns
a localized display name.
Note:
For most categories, eBay does not convert item condition data in
the older AttributeSetArray, LookupAttributeArray, or ItemSpecifics
format to this format in older listings or when you revise or
relist items.
This means GTC listings and older ended or sold listings
may still return the item condition in these other fields even after
new listings only support ConditionID.
There are a few categories in which automatic mapping does occur,
where the old and newer conditions are identical. See the “Automatic Mapping"
tab in the Item Condition Look-up Table link below for details.
Also, if you specified ConditionID but the category also supports
condition in item specifics, you may receive a
"Dropped condition from Item specifics” warning.
You can ignore this warning as long as you used ConditionID.
-
conditionDescription
This string field is used by the seller to more clearly describe the condition of
property
items that are not brand new.
The ConditionDescription field is available for all
categories, including categories where the condition type is not applicable
(e.g., Antiques). This field is applicable for all item conditions except
“New”, “Brand New”, “New with tags”, and “New in box”. If
ConditionDescription is used with these conditions (Condition
IDs 1000-1499), eBay will simply ignore this field if included, and eBay will
return a warning message to the user.
This field should only be used to further clarify the condition of the used item.
For example, “The right leg of the chair has a small scratch, and on the seat
back there is a light blue stain about the shape and size of a coin.” It should
not be used for branding, promotions, shipping, returns, payment or other
information unrelated to the condition of the item. Make sure that the condition
type (Item.ConditionID), condition description, item description
(Item.Description), and the listing’s pictures do not contradict
one another.
The ConditionDescription field is optional For Add/Revise/Relist
API calls. However, this field may become required in some categories starting
with the Spring 2013 Seller Release.
The ConditionDescription field is returned by GetItem
(and other related calls that return the Item object) if a condition description
is specified in the listing. -
conditionDisplayName
The human-readable label for the item condition.
property
Display names are localized for the site on
which they’re listed (not necessarily the site on which
they’re viewed).
Most categories use the same display name for the
same condition ID. Some categories may override the display name
based on buyer expectations for items in the category.
For example, condition ID 1000 could be called
“New” in one category and “New with tags” in another.
Behind the scenes, eBay’s search engine uses the ID
(not the display name) to determine whether items are
new, used, or refurbished.
Only returned when the seller specified ConditionID in their
listing. -
taxCategory
Tax exception category code. This is to be used only
property
by sellers who have opted into sales tax being calculated
by a sales tax calculation vendor. If you are interested
in becoming a tax calculation vendor partner with eBay,
contact<EMAIL_ADDRESS>-
quantityAvailableHint
Indicates the type of message that will be returned describing the quantity
property
available for the item. -
quantityThreshold
The quantity threshold above which the seller prefers not to show the actual
property
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. -
postCheckoutExperienceEnabled
Reserved for future use.
property -
discountPriceInfo
This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price
property
(MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings and auction listings with the Buy
It Now opton. 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
“special account flag” (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation
items. Sellers should contact their account manager or Customer Service to
see if they qualify for the Strikethrough Pricing program.
As a seller listing Discount Price items, you are required to maintain records of your discount
pricing in the event you are called upon to substantiate your item pricing. The following
link details your legal obligations when you utilize Discount Pricing to sell items: Strikethrough Pricing Requirements
For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and
VerifyAddFixedPriceItem:
If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation. -
useRecommendedProduct
If true, and the item details in the request match a product in the eBay catalog, the matching product is used to list the item. This is like using ProductListingDetails to list an item. Applies only to catalog-enabled categories.
property
This feature is available to a small subset of eBay-selected sellers.
Not applicable to Half.com. -
sellerProvidedTitle
A descriptive free-text title for a US or CA eBay Motors vehicle
property
listing. This title appears below eBay’s pre-filled listing title
on the View Item page (not at the top of the View Item page).
It’s also appended to the listing title in search results
(like a subtitle) on the US eBay Motors site.
Keywords in this title help buyers find or distinguish
your listing.
Applicable to listings in US eBay Motors Cars and Trucks,
Motorcycle, and some of the Powersport, Boats and RV campers
categories; or to Cars and Trucks listings on CA eBay Motors.
This replaces the older US and Canada eBay Motors Subtitle attribute
(attribute ID 10246).
Not applicable to Half.com. -
vin
Vehicle Identification Number, which is a unique serial number
property
for a motor vehicle.
Applicable to listings in US eBay Motors Cars and Trucks (6001),
Motorcycles (6024), Commercial Trucks (63732),
RVs and Campers (50054), ATVs (6723), Snowmobiles (42595),
and UTVs (173665);
and to Cars and Trucks listings in CA, CAFR and AU eBay Motors.
For vehicle categories that do not use VIN,
call GetCategorySpecifics to determine applicable
custom item specifics (such as “Hull ID Number” for Boats).
For the US, CA, and CAFR eBay Motors sites, required for cars and
trucks from model year 1981 and later. (The US developed national standards for VIN values as of 1981.)
For the eBay Australia site, required for vehicles from model year
1989 or later. For the eBay Australia site, only appears on the View Item page if you also specify the date of first registration in the listing’s item specifics.
Appears in the VIN field in the Item Specifics section of eBay's
View Item page.
Not applicable to Half.com. -
vinLink
Link to the Vehicle History Report for the vehicle whose VIN was
property
specified in Item.VIN. If no vehicle history report is available, eBay may instead show a plain-text copy of the VIN.
Applicable to listings in US eBay Motors Cars and Trucks, Motorcycle, and some Powersport, Boats and RV campers categories;
and to Cars and Trucks listings in CA, CAFR and AU eBay Motors.
For the eBay Australia site, only appears on the View Item page if
you specify Item.VIN and you also specify the date of
first registration in the listing’s item specifics.
Not applicable to Half.com. -
vrm
Vehicle Registration Mark, which is a unique identifier for
property
a motor vehicle.
Applicable to listings in UK eBay Motors Cars and Trucks,
Motorcycle, and some Powersport categories.
Appears as a VRM field in the Item Specifics section of eBay's
View Item page. On the View Item page, the VRM value is masked
(i.e., only a portion of the value is shown to users).
In the GetItem response, the VRM is only returned if the
call is made by the seller (i.e., the AuthToken is associated
with the vehicle’s seller).
Not applicable to Half.com. -
vrmLink
Link to the Vehicle History Report for the vehicle whose VRM was
property
specified in Item.VRM. The report is visible to all users.
If no vehicle history report is available, eBay may instead show a
plain-text copy of the masked VRM.
Applicable to listings in UK eBay Motors Cars and Trucks, Motorcycle, and some Powersport categories.
Not applicable to Half.com. -
quantityInfo
This container is used to set the minimum number of event tickets that should
property
remain available after a buyer makes a purchase. This functionality allows the
seller to avoid the possibility of being left with just one event ticket after
a sale.
This container can be used when adding, revising, or relisting event tickets, and
it will only be returned in GetItem if set for the listing. -
sellerProfiles
Root container consisting of references to one or more Business Policies profiles.
property
Exactly one Payment Profile, one Shipping Profile, and one Return Policy Profile
may be applied to the listing.
Note:
Business Policies are not yet available for use on the eBay platform.
-
shippingPackageDetails
Container consisting of dimension and size details related to a shipping package in
property
which an item will be sent. The information in this container is applicable if the
seller is using calculated shipping or flat rate shipping using shipping rate tables
with weight surcharges. This container is only returned in the “Get” calls if specified
for the item. -
topRatedListing
This field applies only to the US site, and will be returned only if the US seller qualifies as a Top-Rated Seller.
If this flag is returned for a listing, it indicates that the listing meets the new requirements for a Top-Rated Plus listing. A Top-Rated Plus listing must meet the following requirements:- 14-day (or longer) return policy with Money Back option
- 1-day Handling Time or better
property
A Top-Rated Plus seal appears on the View Item page for qualifying listings. Top-Rated Sellers get a 20 percent discount on their Final Value Fee for all listings that qualify as Top-Rated Plus.
See eBay’s Top Rated Seller Resource Center for more information about how to qualify as a Top-Rated Seller. -
floorPrice
This value sets the minimum price threshold for a seller’s product price in a fixed-price
property
listing. Regardless of the product price on eBay Value Box or Amazon listings, the seller's
product price will not be reduced lower than this dollar value.
This value is only applicable to sellers using the Dynamic Pricing API, and if a dynamic
pricing rule is assigned to the listing’s product. -
ceilingPrice
This value sets the maximum price threshold for a seller’s product price in a fixed-price
property
listing. Regardless of the product price on Amazon or eBay Value Box, the seller’s product
price will not be raised higher than this dollar value.
This value is only applicable to sellers using the Dynamic Pricing API, and if a dynamic
pricing rule is assigned to the listing’s product. If this field is not specified through
the Dynamic Pricing API, an eBay system-level threshold is used to avoid any undesirable
results. -
quantityRestrictionPerBuyer
This container is used by the seller to restrict the quantity of items that may be
property
purchased by one buyer during the duration of a fixed-price listing (single or
multi-variation). This is an optional container that can be used with an Add,
Revise, or Relist call.
This container is not applicable to auction listings. -
isIntermediatedShippingEligible
propertyIf true, sellers can offer eBay's Global Shipping Program when listing the specified item.
-
unitInfo
Contains information about the weight, volume or other quantity measurement of a listed item. The European Union requires listings for certain types of products to include the price per unit so buyers can accurately compare prices. eBay uses the UnitInfo data and the item’s listed price to calculate and display the per-unit price on eBay EU sites.
property
Note: This information is currently required only for EU business sellers, and only for listings with a Buy It Now option.
-
relistParentID
The eBay Item ID of the current item’s parent (original) listing. Only a relisted
property
item will have a parent item, so this field will only be returned if the current
item is a relisted item. -
conditionDefinition
This field is not returned by any Trading API calls, and will be deprecated soon.
property -
hideFromSearch
If this field is returned in GetItem as ‘true’, the auction
property
listing is being hidden from search on the eBay site. This field is not returned
if ‘false’.
To see the reason why the auction listing is being hidden from search, take a look
at the value returned in the ReasonHideFromSearch field.
Currently, only auction listings that have been determined to be duplicate listings
with zero bids are hidden from search, but there may be other reasons to hide
auction listings from search in the future.
Is it possible that a previously hidden listing will be resurfaced in search if the
original auction listing or other duplicate listings get bids or are purchased
through Buy It Now.
It is also possible that eBay will administratively end duplicate auction listings
with zero bids. If this occurs, the listing fee will be credited back to the
seller’s account, and the value returned in the
AccountDetailsEntryType field of the GetAccount
API call will be CreditAuctionEndEarly.
This field is associated with eBay Duplicate Listings Policy, which has taken
effect on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites.
Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this
policy. For more information, read
eBay’s Duplicate Listings Policy help page. -
reasonHideFromSearch
The enumeration value in this field indicates why the auction listing is being
property
hidden from search on the eBay site. This field is only returned if the
HideFromSearch field is returned as ‘true’ in the
GetItem response.
Currently, only auction listings that have been determined to be duplicate listings
with zero bids are hidden from search, but there may be other reasons to hide
auction listings from search in the future.
This field is associated with eBay Duplicate Listings Policy, which has taken
effect on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites.
Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this
policy. For more information, read
eBay’s Duplicate Listings Policy help page. -
any
(public property)
property
Properties
any
(public property)
@property (nonatomic, retain) NSMutableArray *any
Discussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_ItemType.h
applicationData
Returns custom, application-specific data associated with the item.
The data you specify is stored by eBay with the item for your own
reference, but it is not used by eBay in any way. Use
ApplicationData to store special information for yourself, such as
a part number. For a SKU in an eBay.com listing, use the SKU
element instead. To remove this value when revising or relisting an
item, use DeletedField.
Not applicable to Half.com, use SellerInventoryID instead.
@property (nonatomic, retain) NSString *applicationData
Discussion
Returns custom, application-specific data associated with the item.
The data you specify is stored by eBay with the item for your own
reference, but it is not used by eBay in any way. Use
ApplicationData to store special information for yourself, such as
a part number. For a SKU in an eBay.com listing, use the SKU
element instead. To remove this value when revising or relisting an
item, use DeletedField.
Not applicable to Half.com, use SellerInventoryID instead.
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
applyBuyerProtection
Container consisting of details related to whether or not the
item is eligible for buyer protection and which of the buyer protection
programs will cover the item. This container is not returned if the item is not
eligible for eBay or PayPal buyer protection.
@property (nonatomic, retain) Trading_BuyerProtectionDetailsType *applyBuyerProtection
Discussion
Container consisting of details related to whether or not the
item is eligible for buyer protection and which of the buyer protection
programs will cover the item. This container is not returned if the item is not
eligible for eBay or PayPal buyer protection.
type : class Trading_BuyerProtectionDetailsType
Declared In
Trading_ItemType.h
attributeArray
This container is used to specify one or more item attributes for a Half.com listing. This
container is not applicable for eBay fixed-price or auction listings.
You can use ReviseItem to modify attribute values for Half.com
listings.
Half.com listing attributes are not returned in GetItem.
@property (nonatomic, retain) Trading_AttributeArrayType *attributeArray
Discussion
This container is used to specify one or more item attributes for a Half.com listing. This
container is not applicable for eBay fixed-price or auction listings.
You can use ReviseItem to modify attribute values for Half.com
listings.
Half.com listing attributes are not returned in GetItem.
type : class Trading_AttributeArrayType
Declared In
Trading_ItemType.h
attributeSetArray
No longer applicable to any categories.
@property (nonatomic, retain) Trading_AttributeSetArrayType *attributeSetArray
Declared In
Trading_ItemType.h
autoPay
To create an immediate payment listing, AutoPay must be included and
set to ‘true’ for the Add/Revise/Relist API calls. If the seller does not want to create an
immediate payment item, this field is either omitted, or included and set to ‘false’.
In the Trading API calls that return the AutoPay field, be aware that
the field’s appearance in the output does not necessarily indicate that the listing
contains an immediate payment item, but only that the seller attempted to enable (by
including and setting AutoPay to ‘true’ in the request) the immediate
payment option.
In order for a seller to apply an immediate payment policy for an item, the following must
be true:
- [seller](#//api/name/seller) must have a Premier or Business PayPal account;
- [seller](#//api/name/seller) must provide a valid Item.PayPalEmailAddress value;
- [seller](#//api/name/seller) must offer 'PayPal' as the only Item.PaymentMethod value;
- the listing [site](#//api/name/site) supports PayPal payments;
- the category supports PayPal payments;
- the listing type is fixed-price or auction (with Buy It Now option)
To discover if a category supports immediate payment for an item, use
GetCategories and look for the appearance of
the AutoPayEnabled boolean field in the output for that category
(identified by CategoryID). AutoPayEnabled is
returned as an empty element if the category supports immediate payment, and is
not returned at all if the category does not support immediate payment.
Not applicable to Half.com.
@property (nonatomic, retain) NSNumber *autoPay
Discussion
To create an immediate payment listing, AutoPay must be included and
set to ‘true’ for the Add/Revise/Relist API calls. If the seller does not want to create an
immediate payment item, this field is either omitted, or included and set to ‘false’.
In the Trading API calls that return the AutoPay field, be aware that
the field’s appearance in the output does not necessarily indicate that the listing
contains an immediate payment item, but only that the seller attempted to enable (by
including and setting AutoPay to ‘true’ in the request) the immediate
payment option.
In order for a seller to apply an immediate payment policy for an item, the following must
be true:
- [seller](#//api/name/seller) must have a Premier or Business PayPal account;
- [seller](#//api/name/seller) must provide a valid Item.PayPalEmailAddress value;
- [seller](#//api/name/seller) must offer 'PayPal' as the only Item.PaymentMethod value;
- the listing [site](#//api/name/site) supports PayPal payments;
- the category supports PayPal payments;
- the listing type is fixed-price or auction (with Buy It Now option)
To discover if a category supports immediate payment for an item, use
GetCategories and look for the appearance of
the AutoPayEnabled boolean field in the output for that category
(identified by CategoryID). AutoPayEnabled is
returned as an empty element if the category supports immediate payment, and is
not returned at all if the category does not support immediate payment.
Not applicable to Half.com.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
bestOfferDetails
Container for BestOffer properties associated with the item.
Not applicable to Half.com.
@property (nonatomic, retain) Trading_BestOfferDetailsType *bestOfferDetails
Discussion
Container for BestOffer properties associated with the item.
Not applicable to Half.com.
type : class Trading_BestOfferDetailsType
Declared In
Trading_ItemType.h
bestOfferEnabled
Indicates, when true, that an item is available by Best Offer.
@property (nonatomic, retain) NSNumber *bestOfferEnabled
Discussion
Indicates, when true, that an item is available by Best Offer.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
bidGroupItem
This flag is set to true if a watched item belongs to a bid
group. It will only be returned for the Watch container.
@property (nonatomic, retain) NSNumber *bidGroupItem
Discussion
This flag is set to true if a watched item belongs to a bid
group. It will only be returned for the Watch container.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
biddingDetails
Detailed information about a bid. For GetMyeBayBuying, returned as
a self-closed element if no bids meet the request criteria.
Not applicable to Half.com.
@property (nonatomic, retain) Trading_BiddingDetailsType *biddingDetails
Discussion
Detailed information about a bid. For GetMyeBayBuying, returned as
a self-closed element if no bids meet the request criteria.
Not applicable to Half.com.
type : class Trading_BiddingDetailsType
Declared In
Trading_ItemType.h
businessSellerDetails
Returns the seller’s information (in a business card format)
if the seller’s SellerBusinessCodeType is set to ‘Commercial’.
This is only applicable for sites where Business Seller options
are supported.
@property (nonatomic, retain) Trading_BusinessSellerDetailsType *businessSellerDetails
Discussion
Returns the seller’s information (in a business card format)
if the seller’s SellerBusinessCodeType is set to ‘Commercial’.
This is only applicable for sites where Business Seller options
are supported.
type : class Trading_BusinessSellerDetailsType
Declared In
Trading_ItemType.h
buyItNowPrice
For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy
It Now price and end the auction immediately. Use this field to specify the Buy It Now
price. Including and specifying a BuyItNowPrice value enables the
Buy It Now feature for the auction listing.
There is a minimum percentage value that the Buy It Now price must be set above
the Start Price. This minimum percentage value varies by site. To see the valid values
for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails,
and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response.
If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid.
This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com
listings.
Once an auction has bids (and the high bid exceeds the Reserve Price,
if specified), the listing is no longer eligible for Buy It Now (with some
exceptions noted below). However, calls like GetItem
still return the BuyItNowPrice that the seller originally set for the
listing. Use the GetItem call and look for the inclusion of the
Item.ListingDetails.BuyItNowAvailable flag in the output to determine
whether the item can still be purchased using Buy It Now. You can also view the
Item.SellingStatus.BidCount value in other item retrieval
calls to determine whether an auction with Buy It Now has bids or not.
There might be price limits imposed for Buy It Now items, subject to the
seller’s PayPal account or the payment method used. Such limits cannot be
determined via the eBay API and are not covered in eBay’s API documentation
because they can vary for each user.
To remove this value when revising or relisting an item, use DeletedField.
@property (nonatomic, retain) Trading_AmountType *buyItNowPrice
Discussion
For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy
It Now price and end the auction immediately. Use this field to specify the Buy It Now
price. Including and specifying a BuyItNowPrice value enables the
Buy It Now feature for the auction listing.
There is a minimum percentage value that the Buy It Now price must be set above
the Start Price. This minimum percentage value varies by site. To see the valid values
for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails,
and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response.
If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid.
This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com
listings.
Once an auction has bids (and the high bid exceeds the Reserve Price,
if specified), the listing is no longer eligible for Buy It Now (with some
exceptions noted below). However, calls like GetItem
still return the BuyItNowPrice that the seller originally set for the
listing. Use the GetItem call and look for the inclusion of the
Item.ListingDetails.BuyItNowAvailable flag in the output to determine
whether the item can still be purchased using Buy It Now. You can also view the
Item.SellingStatus.BidCount value in other item retrieval
calls to determine whether an auction with Buy It Now has bids or not.
There might be price limits imposed for Buy It Now items, subject to the
seller’s PayPal account or the payment method used. Such limits cannot be
determined via the eBay API and are not covered in eBay’s API documentation
because they can vary for each user.
To remove this value when revising or relisting an item, use DeletedField.
type : class Trading_AmountType
Declared In
Trading_ItemType.h
buyerGuaranteePrice
For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection
coverage, offered for the item at the time of purchase. Details of coverage
are in the following sections of the View Item page: the Buy Safely section
and the Payment Details section.
@property (nonatomic, retain) Trading_AmountType *buyerGuaranteePrice
Discussion
For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection
coverage, offered for the item at the time of purchase. Details of coverage
are in the following sections of the View Item page: the Buy Safely section
and the Payment Details section.
type : class Trading_AmountType
Declared In
Trading_ItemType.h
buyerProtection
Flag to indicate an item’s eligibility for the PayPal Buyer Protection
program. This field is only returned if ‘true’. If this field is not returned, the item is not eligible for PayPal Buyer Protection. For more information on
items that are eligible for PayPal Buyer Protection, see the
PayPal Buyer Protection help page.
Not applicable to Half.com.
@property (nonatomic, retain) NSString *buyerProtection
Discussion
Flag to indicate an item’s eligibility for the PayPal Buyer Protection
program. This field is only returned if ‘true’. If this field is not returned, the item is not eligible for PayPal Buyer Protection. For more information on
items that are eligible for PayPal Buyer Protection, see the
PayPal Buyer Protection help page.
Not applicable to Half.com.
type: string constant in Trading_BuyerProtectionCodeType.h
Declared In
Trading_ItemType.h
buyerRequirementDetails
When this container is present in an AddItem or AddFixedPriceItem call, all
buyer requirements for the resulting listing are set by this container.
Furthermore, individual buyer requirements cannot be modified or added when
including this container in a ReviseItem call. The ReviseItem call needs to
provide the entire set of buyer requirements to modify or add any of the
requirements. Unless otherwise specified, most buyer requirements are only
returned if the caller is the seller. All global My eBay Buyer Requirements
are overridden by the contents of this container. This means that buyer
requirements set in My eBay cannot be combined with buyer requirements
included in this container.
Not applicable to Half.com.
@property (nonatomic, retain) Trading_BuyerRequirementDetailsType *buyerRequirementDetails
Discussion
When this container is present in an AddItem or AddFixedPriceItem call, all
buyer requirements for the resulting listing are set by this container.
Furthermore, individual buyer requirements cannot be modified or added when
including this container in a ReviseItem call. The ReviseItem call needs to
provide the entire set of buyer requirements to modify or add any of the
requirements. Unless otherwise specified, most buyer requirements are only
returned if the caller is the seller. All global My eBay Buyer Requirements
are overridden by the contents of this container. This means that buyer
requirements set in My eBay cannot be combined with buyer requirements
included in this container.
Not applicable to Half.com.
type : class Trading_BuyerRequirementDetailsType
Declared In
Trading_ItemType.h
buyerResponsibleForShipping
Applicable for listings in vehicle categories on the US eBay Motors site and
eBay Canada site. (No business effect if specified for other categories or
sites, as the Web site will not display the information to buyers.) If true,
the buyer is responsible for vehicle pickup or shipping. If false, specify
vehicle shipping arrangements in the item description. Default is true. (The
description can also include vehicle shipping arrangements when this value is
true.) If the item has bids or ends within 12 hours, you cannot modify this
flag. Do not specify ShippingDetails.ShippingServiceOptions
for vehicle listings.
If true and the listing is on the US eBay Motors site, and you want the
listing to be visible on the eBay Canada site, set Item.ShipToLocations to CA.
If true and the listing is on the eBay Canada site , and you want your listing
to be visible on the US eBay Motors site, set Item.ShipToLocations to US.
Not applicable to Half.com.
@property (nonatomic, retain) NSNumber *buyerResponsibleForShipping
Discussion
Applicable for listings in vehicle categories on the US eBay Motors site and
eBay Canada site. (No business effect if specified for other categories or
sites, as the Web site will not display the information to buyers.) If true,
the buyer is responsible for vehicle pickup or shipping. If false, specify
vehicle shipping arrangements in the item description. Default is true. (The
description can also include vehicle shipping arrangements when this value is
true.) If the item has bids or ends within 12 hours, you cannot modify this
flag. Do not specify ShippingDetails.ShippingServiceOptions
for vehicle listings.
If true and the listing is on the US eBay Motors site, and you want the
listing to be visible on the eBay Canada site, set Item.ShipToLocations to CA.
If true and the listing is on the eBay Canada site , and you want your listing
to be visible on the US eBay Motors site, set Item.ShipToLocations to US.
Not applicable to Half.com.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
categoryBasedAttributesPrefill
Allows eBay to auto-fill some of a listing’s Item Specifics (attribute) values
based on the listing’s category (or categories). Auto-filling attributes based
on a category is not the same as using Pre-filled Item Information based on a
catalog product (see ProductListingDetails). If true, also specify
Item.CategoryMappingAllowed with a value of true. See the Trading API Guide for more information.
Ignored if the category does not support auto-filling attributes.
If you also pass in attributes in AttributeSetArray, your values will override
any auto-filled values for the same attributes. Once you have overridden the
value of an auto-filled attribute for a given listing, eBay will not auto-fill
it on subsequent ReviseItem requests (even if you remove the overridden
value).
Not applicable to Half.com.
@property (nonatomic, retain) NSNumber *categoryBasedAttributesPrefill
Discussion
Allows eBay to auto-fill some of a listing’s Item Specifics (attribute) values
based on the listing’s category (or categories). Auto-filling attributes based
on a category is not the same as using Pre-filled Item Information based on a
catalog product (see ProductListingDetails). If true, also specify
Item.CategoryMappingAllowed with a value of true. See the Trading API Guide for more information.
Ignored if the category does not support auto-filling attributes.
If you also pass in attributes in AttributeSetArray, your values will override
any auto-filled values for the same attributes. Once you have overridden the
value of an auto-filled attribute for a given listing, eBay will not auto-fill
it on subsequent ReviseItem requests (even if you remove the overridden
value).
Not applicable to Half.com.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
categoryMappingAllowed
Controls how eBay handles cases in which an ID specified in
PrimaryCategory and/or SecondaryCategory no longer
exists in the current category structure: If you pass a value of ‘true’ in
CategoryMappingAllowed, eBay will look up the current category ID that
is mapped to the same category and use the new category ID for the listing (if any). The
new category ID will be returned in the response as CategoryID (for
the primary category) or Category2ID (for the secondary category). If
CategoryMappingAllowed is not set or contains a value of ‘false’ (the
default), an error will be returned if a selected category ID no longer exists.
Not applicable to Half.com.
@property (nonatomic, retain) NSNumber *categoryMappingAllowed
Discussion
Controls how eBay handles cases in which an ID specified in
PrimaryCategory and/or SecondaryCategory no longer
exists in the current category structure: If you pass a value of ‘true’ in
CategoryMappingAllowed, eBay will look up the current category ID that
is mapped to the same category and use the new category ID for the listing (if any). The
new category ID will be returned in the response as CategoryID (for
the primary category) or Category2ID (for the secondary category). If
CategoryMappingAllowed is not set or contains a value of ‘false’ (the
default), an error will be returned if a selected category ID no longer exists.
Not applicable to Half.com.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
ceilingPrice
This value sets the maximum price threshold for a seller’s product price in a fixed-price
listing. Regardless of the product price on Amazon or eBay Value Box, the seller’s product
price will not be raised higher than this dollar value.
This value is only applicable to sellers using the Dynamic Pricing API, and if a dynamic
pricing rule is assigned to the listing’s product. If this field is not specified through
the Dynamic Pricing API, an eBay system-level threshold is used to avoid any undesirable
results.
@property (nonatomic, retain) Trading_AmountType *ceilingPrice
Discussion
This value sets the maximum price threshold for a seller’s product price in a fixed-price
listing. Regardless of the product price on Amazon or eBay Value Box, the seller’s product
price will not be raised higher than this dollar value.
This value is only applicable to sellers using the Dynamic Pricing API, and if a dynamic
pricing rule is assigned to the listing’s product. If this field is not specified through
the Dynamic Pricing API, an eBay system-level threshold is used to avoid any undesirable
results.
type : class Trading_AmountType
Declared In
Trading_ItemType.h
charity
Identifies a Giving Works listing and the benefiting nonprofit charity
organization selected by the charity seller (if any). If specified, the
seller must also accept PayPal as a payment method for the item (see
Item.PaymentMethods).
When you revise an item, you can add a charity to a non-charity listing, but
you cannot remove or change the charity designation. The rules for adding a
charity to a listing depend on the listing type. For an auction listing, you
can revise an item to add a charity if there are more than 12 hours left for
the listing (whether or not the item has bids). For a fixed-price listing,
you can revise an item to add a charity if there are more than 12 hours left
for the listing, and the item has not been sold.
When you relist an item, use DeletedField to remove charity
information.
Not applicable to Half.com.
@property (nonatomic, retain) Trading_CharityType *charity
Discussion
Identifies a Giving Works listing and the benefiting nonprofit charity
organization selected by the charity seller (if any). If specified, the
seller must also accept PayPal as a payment method for the item (see
Item.PaymentMethods).
When you revise an item, you can add a charity to a non-charity listing, but
you cannot remove or change the charity designation. The rules for adding a
charity to a listing depend on the listing type. For an auction listing, you
can revise an item to add a charity if there are more than 12 hours left for
the listing (whether or not the item has bids). For a fixed-price listing,
you can revise an item to add a charity if there are more than 12 hours left
for the listing, and the item has not been sold.
When you relist an item, use DeletedField to remove charity
information.
Not applicable to Half.com.
type : class Trading_CharityType
Declared In
Trading_ItemType.h
classifiedAdPayPerLeadFee
The pay-per-lead feature is no longer available, and this field is scheduled to
be removed from the WSDL.
@property (nonatomic, retain) Trading_AmountType *classifiedAdPayPerLeadFee
Discussion
The pay-per-lead feature is no longer available, and this field is scheduled to
be removed from the WSDL.
type : class Trading_AmountType
Declared In
Trading_ItemType.h
conditionDefinition
This field is not returned by any Trading API calls, and will be deprecated soon.
@property (nonatomic, retain) NSString *conditionDefinition
Discussion
This field is not returned by any Trading API calls, and will be deprecated soon.
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
conditionDescription
This string field is used by the seller to more clearly describe the condition of
items that are not brand new.
The ConditionDescription field is available for all
categories, including categories where the condition type is not applicable
(e.g., Antiques). This field is applicable for all item conditions except
“New”, “Brand New”, “New with tags”, and “New in box”. If
ConditionDescription is used with these conditions (Condition
IDs 1000-1499), eBay will simply ignore this field if included, and eBay will
return a warning message to the user.
This field should only be used to further clarify the condition of the used item.
For example, “The right leg of the chair has a small scratch, and on the seat
back there is a light blue stain about the shape and size of a coin.” It should
not be used for branding, promotions, shipping, returns, payment or other
information unrelated to the condition of the item. Make sure that the condition
type (Item.ConditionID), condition description, item description
(Item.Description), and the listing’s pictures do not contradict
one another.
The ConditionDescription field is optional For Add/Revise/Relist
API calls. However, this field may become required in some categories starting
with the Spring 2013 Seller Release.
The ConditionDescription field is returned by GetItem
(and other related calls that return the Item object) if a condition description
is specified in the listing.
@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.
The ConditionDescription field is available for all
categories, including categories where the condition type is not applicable
(e.g., Antiques). This field is applicable for all item conditions except
“New”, “Brand New”, “New with tags”, and “New in box”. If
ConditionDescription is used with these conditions (Condition
IDs 1000-1499), eBay will simply ignore this field if included, and eBay will
return a warning message to the user.
This field should only be used to further clarify the condition of the used item.
For example, “The right leg of the chair has a small scratch, and on the seat
back there is a light blue stain about the shape and size of a coin.” It should
not be used for branding, promotions, shipping, returns, payment or other
information unrelated to the condition of the item. Make sure that the condition
type (Item.ConditionID), condition description, item description
(Item.Description), and the listing’s pictures do not contradict
one another.
The ConditionDescription field is optional For Add/Revise/Relist
API calls. However, this field may become required in some categories starting
with the Spring 2013 Seller Release.
The ConditionDescription field is returned by GetItem
(and other related calls that return the Item object) if a condition description
is specified in the listing.
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
conditionDisplayName
The human-readable label for the item condition.
Display names are localized for the site on
which they’re listed (not necessarily the site on which
they’re viewed).
Most categories use the same display name for the
same condition ID. Some categories may override the display name
based on buyer expectations for items in the category.
For example, condition ID 1000 could be called
“New” in one category and “New with tags” in another.
Behind the scenes, eBay’s search engine uses the ID
(not the display name) to determine whether items are
new, used, or refurbished.
Only returned when the seller specified ConditionID in their
listing.
@property (nonatomic, retain) NSString *conditionDisplayName
Discussion
The human-readable label for the item condition.
Display names are localized for the site on
which they’re listed (not necessarily the site on which
they’re viewed).
Most categories use the same display name for the
same condition ID. Some categories may override the display name
based on buyer expectations for items in the category.
For example, condition ID 1000 could be called
“New” in one category and “New with tags” in another.
Behind the scenes, eBay’s search engine uses the ID
(not the display name) to determine whether items are
new, used, or refurbished.
Only returned when the seller specified ConditionID in their
listing.
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
conditionID
The numeric ID (e.g., 1000) for the item condition.
Sellers should also clarify the item’s condition in their
own item description.
Note:
In addition to including notes on flaws or wear and tear on an used item in the
Item.Description, and including a ConditionID
value, you can provide additional information about the condition of your used item
through the Item.ConditionDescription string field.
For the AddItem family of calls:
Use GetCategoryFeatures for details about which categories support
(or require) ConditionID, plus policies and help on choosing the
right condition for the item (to reduce disputes).
Please note the following behavior if you pass a ConditionID value
that is not valid for the category: If ConditionID is disabled
(or not applicable) for the category, the item is listed with no
condition. If ConditionID is enabled or required for the category, the listing
request fails.
If you are listing in two categories, the primary category determines which
condition model (ConditionID or item specifics) and which condition values
can be used.
US eBay Motors Parts & Accessories and vehicle categories require ConditionID for new
listings and re-listings.
Not applicable to Half.com in listing requests (e.g., AddItem).
However, ConditionID could be returned in responses for
Half.com listings that are available to or sold on the
eBay site (as appropriate for the corresponding eBay category).
For Revise/Relist calls: In most cases, you can add or modify
ConditionID when you revise or relist.
If GetCategoryFeatures returns ConditionEnabled=Required for the
listing’s category, you cannot remove ConditionID from the listing.
If an auction has bids or ends within 12 hours, you cannot remove or
change its condition, and you cannot replace a condition
attribute or custom item specific with ConditionID. In this case,