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.
@property (nonatomic, retain) NSNumber *conditionID
Discussion
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,
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.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ItemType.h
country
Defines the 2-letter country code set.
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’).
@property (nonatomic, retain) NSString *country
Discussion
Defines the 2-letter country code set.
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’).
type: string constant in Trading_CountryCodeType.h
Declared In
Trading_ItemType.h
crossBorderTrade
This field is used by sellers who want their listing to be returned in the search
results for other eBay sites. This feature is currently only supported by the US, UK,
eBay Canada, and eBay Ireland sites. See Getting exposure on
international sites for full requirements on using this feature. There is a
small listing fee for each country specified as a Cross Border Trade country.
US listings that offer shipping to Canada, North America, or worldwide are
automatically returned on eBay.ca at no extra charge, so US listings that offer
shipping to these locations do not need to specify Canada as a Cross Border Trade
country.
@property (nonatomic, retain) NSMutableArray *crossBorderTrade
Discussion
This field is used by sellers who want their listing to be returned in the search
results for other eBay sites. This feature is currently only supported by the US, UK,
eBay Canada, and eBay Ireland sites. See Getting exposure on
international sites for full requirements on using this feature. There is a
small listing fee for each country specified as a Cross Border Trade country.
US listings that offer shipping to Canada, North America, or worldwide are
automatically returned on eBay.ca at no extra charge, so US listings that offer
shipping to these locations do not need to specify Canada as a Cross Border Trade
country.
entry type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
crossPromotion
This container is no longer supported as eBay Store Cross Promotions are no
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.
@property (nonatomic, retain) Trading_CrossPromotionsType *crossPromotion
Discussion
This container is no longer supported as eBay Store Cross Promotions are no
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.
type : class Trading_CrossPromotionsType
Declared In
Trading_ItemType.h
currency
Currency associated with the item’s price information. 3-letter ISO 4217
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.
@property (nonatomic, retain) NSString *currency
Discussion
Currency associated with the item’s price information. 3-letter ISO 4217
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.
type: string constant in Trading_CurrencyCodeType.h
Declared In
Trading_ItemType.h
description
The seller’s description of the item.
In listing requests, you can submit your description
using CDATA if you want to use HTML or XML-reserved characters in the
description. 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.)
@property (nonatomic, retain) NSString *description
Discussion
The seller’s description of the item.
In listing requests, you can submit your description
using CDATA if you want to use HTML or XML-reserved characters in the
description. 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.)
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
descriptionReviseMode
This field is applicable if you are modifying the item description. The value
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.
@property (nonatomic, retain) NSString *descriptionReviseMode
Discussion
This field is applicable if you are modifying the item description. The value
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.
type: string constant in Trading_DescriptionReviseModeCodeType.h
Declared In
Trading_ItemType.h
disableBuyerRequirements
If true: all buyer requirements (from Item.BuyerRequirementDetails
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.
@property (nonatomic, retain) NSNumber *disableBuyerRequirements
Discussion
If true: all buyer requirements (from Item.BuyerRequirementDetails
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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
discountPriceInfo
This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price
(MAP) discount pricing treatment. STP and MAP 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.
@property (nonatomic, retain) Trading_DiscountPriceInfoType *discountPriceInfo
Discussion
This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price
(MAP) discount pricing treatment. STP and MAP 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.
type : class Trading_DiscountPriceInfoType
Declared In
Trading_ItemType.h
dispatchTimeMax
Specifies the maximum number of business days the seller
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.
@property (nonatomic, retain) NSNumber *dispatchTimeMax
Discussion
Specifies the maximum number of business days the seller
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.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ItemType.h
distance
The distance used in a proximity search distance calculation.
Not applicable to Half.com.
@property (nonatomic, retain) Trading_DistanceType *distance
Discussion
The distance used in a proximity search distance calculation.
Not applicable to Half.com.
type : class Trading_DistanceType
Declared In
Trading_ItemType.h
eBayNotes
Returns a note from eBay displayed below items in the user’s My
eBay account.
Not applicable to Half.com.
@property (nonatomic, retain) NSString *eBayNotes
Discussion
Returns a note from eBay displayed below items in the user’s My
eBay account.
Not applicable to Half.com.
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
extendedSellerContactDetails
Extended contact information for sellers using the Classified Ad format.
Specifies the days and hours when the seller can be contacted.
To remove seller contact information when revising or relisting an item, use
DeletedField.
@property (nonatomic, retain) Trading_ExtendedContactDetailsType *extendedSellerContactDetails
Discussion
Extended contact information for sellers using the Classified Ad format.
Specifies the days and hours when the seller can be contacted.
To remove seller contact information when revising or relisting an item, use
DeletedField.
type : class Trading_ExtendedContactDetailsType
Declared In
Trading_ItemType.h
externalProductID
This field will be removed in a future release.
New applications should use ProductListingDetails instead.
@property (nonatomic, retain) Trading_ExternalProductIDType *externalProductID
Discussion
This field will be removed in a future release.
New applications should use ProductListingDetails instead.
type : class Trading_ExternalProductIDType
Declared In
Trading_ItemType.h
floorPrice
This value sets the minimum price threshold for a seller’s product price in a fixed-price
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.
@property (nonatomic, retain) Trading_AmountType *floorPrice
Discussion
This value sets the minimum price threshold for a seller’s product price in a fixed-price
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.
type : class Trading_AmountType
Declared In
Trading_ItemType.h
freeAddedCategory
ID for a second category that eBay added as a free promotion. You cannot add
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.
@property (nonatomic, retain) Trading_CategoryType *freeAddedCategory
Discussion
ID for a second category that eBay added as a free promotion. You cannot add
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.
type : class Trading_CategoryType
Declared In
Trading_ItemType.h
getItFast
Indicates whether the seller has committed to the GetItFast
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.
@property (nonatomic, retain) NSNumber *getItFast
Discussion
Indicates whether the seller has committed to the GetItFast
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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
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
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.
@property (nonatomic, retain) NSNumber *giftIcon
Discussion
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
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.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ItemType.h
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
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.
@property (nonatomic, retain) NSMutableArray *giftServices
Discussion
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
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.
entry type : string constant in Trading_GiftServicesCodeType.h
Declared In
Trading_ItemType.h
groupCategoryID
GroupCategoryID is returned if there is a value of
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.
@property (nonatomic, retain) NSString *groupCategoryID
Discussion
GroupCategoryID is returned if there is a value of
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.
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
hideFromSearch
If this field is returned in GetItem as ‘true’, the auction
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.
@property (nonatomic, retain) NSNumber *hideFromSearch
Discussion
If this field is returned in GetItem as ‘true’, the auction
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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
hitCount
The number of page views for the item. This number is calculated by eBay and
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.
@property (nonatomic, retain) NSNumber *hitCount
Discussion
The number of page views for the item. This number is calculated by eBay and
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.
type : NSNumber, wrapper for primitive long
Declared In
Trading_ItemType.h
hitCounter
Indicates whether an optional hit counter is displayed on the item’s listing
page and, if so, what type. See HitCounterCodeType for specific values.
Not applicable to Half.com.
@property (nonatomic, retain) NSString *hitCounter
Discussion
Indicates whether an optional hit counter is displayed on the item’s listing
page and, if so, what type. See HitCounterCodeType for specific values.
Not applicable to Half.com.
type: string constant in Trading_HitCounterCodeType.h
Declared In
Trading_ItemType.h
integratedMerchantCreditCardEnabled
Indicates whether the item can be paid for through a payment gateway
(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).
@property (nonatomic, retain) NSNumber *integratedMerchantCreditCardEnabled
Discussion
Indicates whether the item can be paid for through a payment gateway
(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).
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
inventoryTrackingMethod
Indicates whether you prefer to track your eBay listings by
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.
@property (nonatomic, retain) NSString *inventoryTrackingMethod
Discussion
Indicates whether you prefer to track your eBay listings by
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.
type: string constant in Trading_InventoryTrackingMethodCodeType.h
Declared In
Trading_ItemType.h
isIntermediatedShippingEligible
If true, sellers can offer eBay's Global Shipping Program when listing the specified item.
@property (nonatomic, retain) NSNumber *isIntermediatedShippingEligible
Discussion
If true, sellers can offer eBay's Global Shipping Program when listing the specified item.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
itemCompatibilityCount
Indicates the number of compatible applications specified for the given item.
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.
@property (nonatomic, retain) NSNumber *itemCompatibilityCount
Discussion
Indicates the number of compatible applications specified for the given item.
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.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ItemType.h
itemCompatibilityList
A list of parts compatibility information specified as name and value pairs.
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.
@property (nonatomic, retain) Trading_ItemCompatibilityListType *itemCompatibilityList
Discussion
A list of parts compatibility information specified as name and value pairs.
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.
type : class Trading_ItemCompatibilityListType
Declared In
Trading_ItemType.h
itemID
The ID that uniquely identifies the item listing. The ID is generated
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.
@property (nonatomic, retain) NSString *itemID
Discussion
The ID that uniquely identifies the item listing. The ID is generated
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.
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
itemPolicyViolation
Specifies the details of policy violations if the item was administratively
canceled.
@property (nonatomic, retain) Trading_ItemPolicyViolationType *itemPolicyViolation
Discussion
Specifies the details of policy violations if the item was administratively
canceled.
type : class Trading_ItemPolicyViolationType
Declared In
Trading_ItemType.h
itemSpecifics
A list of Item Specific name and value pairs that the
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.)
@property (nonatomic, retain) Trading_NameValueListArrayType *itemSpecifics
Discussion
A list of Item Specific name and value pairs that the
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.)
type : class Trading_NameValueListArrayType
Declared In
Trading_ItemType.h
leadCount
Specifies the number of leads (emails) buyers have posted about the item.
You must be the seller of the item to retrieve the lead count.
@property (nonatomic, retain) NSNumber *leadCount
Discussion
Specifies the number of leads (emails) buyers have posted about the item.
You must be the seller of the item to retrieve the lead count.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ItemType.h
limitedWarrantyEligible
This feature is no longer supported. This field will be removed
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.
@property (nonatomic, retain) NSNumber *limitedWarrantyEligible
Discussion
This feature is no longer supported. This field will be removed
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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
listingCheckoutRedirectPreference
Container consisting of the ProStores store name and user name.
@property (nonatomic, retain) Trading_ListingCheckoutRedirectPreferenceType *listingCheckoutRedirectPreference
Discussion
Container consisting of the ProStores store name and user name.
type : class Trading_ListingCheckoutRedirectPreferenceType
Declared In
Trading_ItemType.h
listingDesigner
Contains the detail data for the Listing Designer theme and template (if either
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.
@property (nonatomic, retain) Trading_ListingDesignerType *listingDesigner
Discussion
Contains the detail data for the Listing Designer theme and template (if either
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.
type : class Trading_ListingDesignerType
Declared In
Trading_ItemType.h
listingDetails
Various details about a listing, some of which are calculated or
derived after the item is listed. These include the start and end
time, converted (localized) prices, and certain flags that indicate
whether the seller specified fields whose values are not visible to
the requesting user. For GetMyeBayBuying, returned as a self-closed
element if no listings meet the request criteria.
Not applicable to Half.com.
@property (nonatomic, retain) Trading_ListingDetailsType *listingDetails
Discussion
Various details about a listing, some of which are calculated or
derived after the item is listed. These include the start and end
time, converted (localized) prices, and certain flags that indicate
whether the seller specified fields whose values are not visible to
the requesting user. For GetMyeBayBuying, returned as a self-closed
element if no listings meet the request criteria.
Not applicable to Half.com.
type : class Trading_ListingDetailsType
Declared In
Trading_ItemType.h
listingDuration
Describes the number of days the seller wants the listing to be active (available
for bidding/buying). The duration specifies the seller’s initial intent at listing
time. The end time for a listing is calculated by adding the duration to the item's
start time. If the listing ends early, the value of the listing duration does not
change. When a listing’s duration is changed, any related fees (e.g., 10-day fee)
may be debited or credited (as applicable).
The valid choice of values depends on the listing format (see Item.ListingType). For
a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll
and look for ListingDurations information. 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).
@property (nonatomic, retain) NSString *listingDuration
Discussion
Describes the number of days the seller wants the listing to be active (available
for bidding/buying). The duration specifies the seller’s initial intent at listing
time. The end time for a listing is calculated by adding the duration to the item's
start time. If the listing ends early, the value of the listing duration does not
change. When a listing’s duration is changed, any related fees (e.g., 10-day fee)
may be debited or credited (as applicable).
The valid choice of values depends on the listing format (see Item.ListingType). For
a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll
and look for ListingDurations information. 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).
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
listingEnhancement
This field can be used by the seller to activate one or more listing upgrades for a
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.
@property (nonatomic, retain) NSMutableArray *listingEnhancement
Discussion
This field can be used by the seller to activate one or more listing upgrades for a
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.
entry type : string constant in Trading_ListingEnhancementsCodeType.h
Declared In
Trading_ItemType.h
listingSubtype2
Indicates a specific type of lead generation format listing, such as
classified ad or local market Best Offer listing. Only applicable when
ListingType=LeadGeneration.
Note:
ListingSubtype2 replaces the deprecated ListingSubtype field.
If both are specified in a request, ListingSubtype2 takes precedence.
@property (nonatomic, retain) NSString *listingSubtype2
Discussion
Indicates a specific type of lead generation format listing, such as
classified ad or local market Best Offer listing. Only applicable when
ListingType=LeadGeneration.
Note:
ListingSubtype2 replaces the deprecated ListingSubtype field.
If both are specified in a request, ListingSubtype2 takes precedence.
type: string constant in Trading_ListingSubtypeCodeType.h
Declared In
Trading_ItemType.h
listingType
The format of the listing the seller wants to use, such as auction style
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).
@property (nonatomic, retain) NSString *listingType
Discussion
The format of the listing the seller wants to use, such as auction style
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).
type: string constant in Trading_ListingTypeCodeType.h
Declared In
Trading_ItemType.h
localListing
Indicates, when true, that an item is available locally.
@property (nonatomic, retain) NSNumber *localListing
Discussion
Indicates, when true, that an item is available locally.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
location
Indicates the geographical location of the item (along with Country).
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.
@property (nonatomic, retain) NSString *location
Discussion
Indicates the geographical location of the item (along with Country).
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.
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
locationDefaulted
True if eBay provided a central location as a result of the user
not specifying a location. This typically occurs when the seller
specifies PostalCode without Location.
Not applicable to Half.com.
@property (nonatomic, retain) NSNumber *locationDefaulted
Discussion
True if eBay provided a central location as a result of the user
not specifying a location. This typically occurs when the seller
specifies PostalCode without Location.
Not applicable to Half.com.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
lookupAttributeArray
No longer applicable to any category. Use ConditionID instead.
@property (nonatomic, retain) Trading_LookupAttributeArrayType *lookupAttributeArray
Discussion
No longer applicable to any category. Use ConditionID instead.
type : class Trading_LookupAttributeArrayType
Declared In
Trading_ItemType.h
lotSize
A lot is a set of two or more similar items included in a single listing that must be
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.
@property (nonatomic, retain) NSNumber *lotSize
Discussion
A lot is a set of two or more similar items included in a single listing that must be
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.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ItemType.h
mechanicalCheckAccepted
Indicates whether the seller allows the bidder to request mechanical
inspection services from RAC. For Car category listings on the UK site.
@property (nonatomic, retain) NSNumber *mechanicalCheckAccepted
Discussion
Indicates whether the seller allows the bidder to request mechanical
inspection services from RAC. For Car category listings on the UK site.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
motorsGermanySearchable
Listing upgrade that features the item in eBay search results on
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.
@property (nonatomic, retain) NSNumber *motorsGermanySearchable
Discussion
Listing upgrade that features the item in eBay search results on
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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
newLeadCount
Specifies the number of new leads (unanswered emails) buyers have posted
about the item.
@property (nonatomic, retain) NSNumber *newLeadCount
Discussion
Specifies the number of new leads (unanswered emails) buyers have posted
about the item.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ItemType.h
partnerCode
Not currently operational.
@property (nonatomic, retain) NSString *partnerCode
Discussion
Not currently operational.
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
partnerName
Not currently operational.
@property (nonatomic, retain) NSString *partnerName
Discussion
Not currently operational.
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
payPalEmailAddress
Valid PayPal email address for the PayPal account that the seller will use
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.
@property (nonatomic, retain) NSString *payPalEmailAddress
Discussion
Valid PayPal email address for the PayPal account that the seller will use
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.
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
paymentAllowedSite
Enables you to view the sites on which an item can be purchased,
based on the payment methods offered for the item.
@property (nonatomic, retain) NSMutableArray *paymentAllowedSite
Discussion
Enables you to view the sites on which an item can be purchased,
based on the payment methods offered for the item.
entry type : string constant in Trading_SiteCodeType.h
Declared In
Trading_ItemType.h
paymentDetails
This container is used by the seller to specify amounts and due dates for deposits and
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).
@property (nonatomic, retain) Trading_PaymentDetailsType *paymentDetails
Discussion
This container is used by the seller to specify amounts and due dates for deposits and
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).
type : class Trading_PaymentDetailsType
Declared In
Trading_ItemType.h
paymentMethods
Identifies the payment method (such as PayPal) that the seller will accept
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.
@property (nonatomic, retain) NSMutableArray *paymentMethods
Discussion
Identifies the payment method (such as PayPal) that the seller will accept
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.
entry type : string constant in Trading_BuyerPaymentMethodCodeType.h
Declared In
Trading_ItemType.h
pictureDetails
Contains the data for a picture associated with an item. With the exception of
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.
@property (nonatomic, retain) Trading_PictureDetailsType *pictureDetails
Discussion
Contains the data for a picture associated with an item. With the exception of
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.
type : class Trading_PictureDetailsType
Declared In
Trading_ItemType.h
postCheckoutExperienceEnabled
Reserved for future use.
@property (nonatomic, retain) NSNumber *postCheckoutExperienceEnabled
Discussion
Reserved for future use.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
postalCode
Postal code of the place where the item is located. This value is used for
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.
@property (nonatomic, retain) NSString *postalCode
Discussion
Postal code of the place where the item is located. This value is used for
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.
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
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”
Getting 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.
@property (nonatomic, retain) Trading_CategoryType *primaryCategory
Discussion
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”
Getting 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.
type : class Trading_CategoryType
Declared In
Trading_ItemType.h
privateListing
The PrivateListing boolean field can be used by the seller in the
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.
@property (nonatomic, retain) NSNumber *privateListing
Discussion
The PrivateListing boolean field can be used by the seller in the
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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
privateNotes
A note a user makes on an item in their My eBay account. The note is prefaced with
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.)
@property (nonatomic, retain) NSString *privateNotes
Discussion
A note a user makes on an item in their My eBay account. The note is prefaced with
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.)
type : NSString, wrapper for primitive string
Declared In
Trading_ItemType.h
productListingDetails
Specifies stock product information to include in a listing.
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.
@property (nonatomic, retain) Trading_ProductListingDetailsType *productListingDetails
Discussion
Specifies stock product information to include in a listing.
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.
type : class Trading_ProductListingDetailsType
Declared In
Trading_ItemType.h
proxyItem
Some listings on the eBay platform originate from eBay affiliates.
Depending on the relationship the affiliate has with eBay, there are times
when the affiliate retains ownership of the listing. When this occurs
the representation of the listing on eBay is considered a proxy item. Proxy
items can only be edited using API requests from the applications that
originally listed them.
@property (nonatomic, retain) NSNumber *proxyItem
Discussion
Some listings on the eBay platform originate from eBay affiliates.
Depending on the relationship the affiliate has with eBay, there are times
when the affiliate retains ownership of the listing. When this occurs
the representation of the listing on eBay is considered a proxy item. Proxy
items can only be edited using API requests from the applications that
originally listed them.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
quantity
The value indicates the quantity of items available for purchase in the listing.
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.
@property (nonatomic, retain) NSNumber *quantity
Discussion
The value indicates the quantity of items available for purchase in the listing.
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.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ItemType.h
quantityAvailable
Specifies how many of a certain item are available.
Not applicable to Half.com.
@property (nonatomic, retain) NSNumber *quantityAvailable
Discussion
Specifies how many of a certain item are available.
Not applicable to Half.com.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ItemType.h
quantityAvailableHint
Indicates the type of message that will be returned describing the quantity
available for the item.
@property (nonatomic, retain) NSString *quantityAvailableHint
Discussion
Indicates the type of message that will be returned describing the quantity
available for the item.
type: string constant in Trading_QuantityAvailableHintCodeType.h
Declared In
Trading_ItemType.h
quantityInfo
This container is used to set the minimum number of event tickets that should
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.
@property (nonatomic, retain) Trading_QuantityInfoType *quantityInfo
Discussion
This container is used to set the minimum number of event tickets that should
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.
type : class Trading_QuantityInfoType
Declared In
Trading_ItemType.h
quantityRestrictionPerBuyer
This container is used by the seller to restrict the quantity of items that may be
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.
@property (nonatomic, retain) Trading_QuantityRestrictionPerBuyerInfoType *quantityRestrictionPerBuyer
Discussion
This container is used by the seller to restrict the quantity of items that may be
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.
type : class Trading_QuantityRestrictionPerBuyerInfoType
Declared In
Trading_ItemType.h
quantityThreshold
The quantity threshold above which the seller prefers not to show the actual
quantity available. Returned when the quantity available is greater than the
value of quantity threshold. Currently, 10 is the only available value for
this threshold.
@property (nonatomic, retain) NSNumber *quantityThreshold
Discussion
The quantity threshold above which the seller prefers not to show the actual
quantity available. Returned when the quantity available is greater than the
value of quantity threshold. Currently, 10 is the only available value for
this threshold.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ItemType.h
questionCount
Specifies the number of questions buyers have posted about the
item. Returned only if greater than 0.
Not applicable to Half.com.
@property (nonatomic, retain) NSNumber *questionCount
Discussion
Specifies the number of questions buyers have posted about the
item. Returned only if greater than 0.
Not applicable to Half.com.
type : NSNumber, wrapper for primitive long
Declared In
Trading_ItemType.h
reasonHideFromSearch
The enumeration value in this field indicates why the auction listing is being
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.
@property (nonatomic, retain) NSString *reasonHideFromSearch
Discussion
The enumeration value in this field indicates why the auction listing is being
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.
type: string constant in Trading_ReasonHideFromSearchCodeType.h
Declared In
Trading_ItemType.h
relistLink
Applicable only to re-listing an item. If true, creates a link in the item's
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.
@property (nonatomic, retain) NSNumber *relistLink
Discussion
Applicable only to re-listing an item. If true, creates a link in the item's
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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
relistParentID
The eBay Item ID of the current item’s parent (original) listing. Only a relisted
item will have a parent item, so this field will only be returned if the current
item is a relisted item.
@property (nonatomic, retain) NSNumber *relistParentID
Discussion
The eBay Item ID of the current item’s parent (original) listing. Only a relisted
item will have a parent item, so this field will only be returned if the current
item is a relisted item.
type : NSNumber, wrapper for primitive long
Declared In
Trading_ItemType.h
relisted
Whether or not the item is a relisted item. This value is
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.
@property (nonatomic, retain) NSNumber *relisted
Discussion
Whether or not the item is a relisted item. This value is
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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ItemType.h
reservePrice
The lowest price at which the seller is willing to sell the item. (StartPrice
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.
@property (nonatomic, retain) Trading_AmountType *reservePrice
Discussion
The lowest price at which the seller is willing to sell the item. (StartPrice
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.
type : class Trading_AmountType
Declared In
Trading_ItemType.h
returnPolicy
Container that describes the seller’s return policy. Most categories on most
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.
@property (nonatomic, retain) Trading_ReturnPolicyType *returnPolicy
Discussion
Container that describes the seller’s return policy. Most categories on most
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.
type : class Trading_ReturnPolicyType
Declared In
Trading_ItemType.h
reviseStatus
An output value only, indicates whether an item has been revised
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.
@property (nonatomic, retain) Trading_ReviseStatusType *reviseStatus
Discussion
An output value only, indicates whether an item has been revised
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.
type : class Trading_ReviseStatusType
Declared In
Trading_ItemType.h
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”
Why scheduled time is sometimes getting reset.
Not applicable to Half.com.
@property (nonatomic, retain) NSDate *scheduleTime
Discussion
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”
Why scheduled time is sometimes getting reset.
Not applicable to Half.com.
type : NSDate, wrapper for primitive date
Declared In
Trading_ItemType.h
searchDetails
Container for values that indicate whether a listing uses the Buy It Now feature,
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.
@property (nonatomic, retain) Trading_SearchDetailsType *searchDetails
Discussion
Container for values that indicate whether a listing uses the Buy It Now feature,
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.
type : class Trading_SearchDetailsType
Declared In
Trading_ItemType.h
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
Clothing, Shoes > Accessories > Men’s Clothing > Outerwear).
If you list on the main eBay site, the primary category could be 57988 and
the secondary category could be 6750.
If eBay has designated a category as a value category
@property (nonatomic, retain) Trading_CategoryType *secondaryCategory
Discussion
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
Clothing, Shoes > Accessories > Men’s Clothing > Outerwear).
If you list on the main eBay site, the primary category could be 57988 and
the secondary category could be 6750.
If eBay has designated a category as a value category
See Also
ValueCategory in GetCategoryFeatures), items in that category
cannot be listed in two categories.
For example, if your AddItem request
includes a primary or secondary category that is a value category, then eBay drops SecondaryCategory and lists
the item with only the PrimaryCategory you selected.
Also, if the listing request includes item specifics
(in ItemSpecifics or AttributeSetArray) that are associated with SecondaryCategory, eBay drops those values when we drop SecondaryCategory. (The same logic is used if you revise an existing
listing to add a secondary category or to change one of the categories: If either the primary or secondary category is a value category, eBay drops the secondary category from your request.)
To remove this value when relisting an item, use DeletedField.
For ReviseItem only: When revising a listing, you
can add or change the secondary category only if the listing has no
bids (or no items have sold) and it does not end within 12 hours. If you
change the secondary category, @property any corresponding Item Specifics (attributes)
that were previously specified may be dropped from the listing if they
aren’t valid for the category. See Item.AttributeSetArray.
When you revise an item, you can change the secondary category from a Motors
Parts & Accessories category to an eBay category or vice versa if the
listing has no bids (or no items have sold) and it does not end within 12
hours.
For GetItemRecommendations only:
For GetItemRecommendations, use this to control the category that will be
searched for recommendations. Specify the category in which the item will be
listed. See the Trading API Guide for differences in validation rules
depending on whether you are using the Listing Analyzer engine, Product
Pricing engine, or Suggested Attributes engine.type : class Trading_CategoryType
Declared In
Trading_ItemType.h
seller
Container for information about this listing’s seller.
Not applicable to Half.com.
Returned by GetItemsAwaitingFeedback if Buyer is making the request.
@property (nonatomic, retain) Trading_UserType *seller
Discussion
Container for information about this listing’s seller.
Not applicable to Half.com.
Returned by GetItemsAwaitingFeedback if Buyer is making the request.
type : class Trading_UserType
Declared In
Trading_ItemType.h
sellerContactDetails
Contact information for sellers using the Classified Ad format for eBay
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
@property (nonatomic, retain) Trading_AddressType *sellerContactDetails
Discussion
Contact information for sellers using the Classified Ad format for eBay
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
type : class Trading_AddressType
Declared In
Trading_ItemType.h
sellerInventoryID