Trading API879

ItemType

Contains the data defining one item. A seller populates an object of this type at listing time with the definition of a new item. A seller also uses an object of this type to relist or revise an item. Calls that retrieve item data (such as the GetSellerList call) return an object of this type, filled with the item's data. Some fields are applicable both to eBay listings and Half.com listings. Some fields are only applicable to eBay listings, and others are only applicable to Half.com listings.

Types that use ItemType:

Calls that use one or more fields of ItemType:

Fields

VIN ( string )
VRM ( string )


ApplicationData ( string ) [0..1]
Returns custom, application-specific data associated with the item. The data you specify is stored by eBay with the item for your own reference, but it is not used by eBay in any way. Use ApplicationData to store special information for yourself, such as a part number. For a SKU in an eBay.com listing, use the SKU element instead. To remove this value when revising or relisting an item, use DeletedField.

Not applicable to Half.com; use SellerInventoryID instead.
See the Field Index to learn which calls use ApplicationData.

ApplyBuyerProtection ( BuyerProtectionDetailsType ) [0..1]
Container consisting of details related to whether or not the item is eligible for buyer protection and which of the buyer protection programs will cover the item. This container is not returned if the item is not eligible for eBay or PayPal buyer protection.
See the Field Index to learn which calls use ApplyBuyerProtection.

AttributeArray ( AttributeArrayType ) [0..1]
This container is used to specify one or more item attributes for a Half.com listing. This container is not applicable for eBay listings.

You can use ReviseItem to modify attribute values for Half.com listings.

Half.com listing attributes are not returned in GetItem.
See the Field Index to learn which calls use AttributeArray.

AttributeSetArray ( AttributeSetArrayType ) [0..1]
No longer applicable to any categories.
See the Field Index to learn which calls use AttributeSetArray.

AutoPay ( boolean ) [0..1]
To create a requirement that a buyer pays immediately (through PayPal or PaisaPay) for an auction (Buy It Now only) or fixed-price item, the seller can include and set the AutoPay field to 'true' for an Add/Revise/Relist API call. If the seller does not want to create an immediate payment item, this field is either omitted, or included and set to 'false'.

If this feature is enabled for a listing, the buyer must pay immediately for the item through PayPal or PaisaPay (India site only), and the buyer's funds are transferred instantly to the seller's PayPal or PaisaPay account. The seller's item will remain available for purchase by other buyers until the buyer actually completes the payment.

In order for a seller to apply an immediate payment requirement for an item, the following must be true:
  • seller must have a Premier or Business PayPal account (or PaisaPay for India sellers);
  • the Buy It Now price (if applicable) cannot be higher than $10,000 USD;
  • the listing site supports PayPal (or PaisaPay for India site) payments;
  • the category supports PayPal (or PaisaPay for India site) payments;
  • the listing type is fixed-price or auction (with Buy It Now option).

To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call:
  • seller must provide a valid Item.PayPalEmailAddress value (not required for India site);
  • seller must offer PayPal as the only payment method, or for the India site, one or more of the three supported PaisaPay payment methods;
  • seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges;
  • seller must include and set the PromotionalShippingDiscount field to true if a promotional shipping discount is being applied to the listing;
  • seller must include the ShippingDiscountProfileID and reference a valid flat or calculated Shipping Discount Profile ID if a flat or calculated shipping rule is being applied to the listing.

In the Trading API calls that return the AutoPay field, be aware that the field's appearance in the output does not necessarily indicate that the immediate payment feature was successfully enabled/used for the active or ended listing, but only that the seller attempted to enable (by including and setting AutoPay to 'true' in the request) the immediate payment feature for the listing.

To discover if a category supports immediate payment for an item, use GetCategories and look for the appearance of the AutoPayEnabled boolean field in the output for that category (identified by CategoryID). AutoPayEnabled is returned as an empty element if the category supports immediate payment, and is not returned at all if the category does not support immediate payment.

Not applicable to Half.com.
See the Field Index to learn which calls use AutoPay.

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

This boolean field will be returned as 'true' if the seller has made the item available for the "Click and Collect" program. With the 'Click and Collect' feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The "Click and Collect" feature is only available to UK sellers. UK buyers should realize that they must be in an area where "Click and Collect" is available. This field is not returned if 'false'.
See the Field Index to learn which calls use AvailableForPickupDropOff.

BestOfferDetails ( BestOfferDetailsType ) [0..1]
For Add/Revise/Relist/Verify calls: This container is used to enable the Best Offer feature on a listing. The Best Offer feature is not available for auction listings.

For GetItem and other calls that retrieve item data, this container will include the status (GetMyeBayBuying only) and dollar amount of the latest Best Offer on a fixed-price listing, and the number of Best Offers received for the fixed-price listing.

Not applicable to Half.com.
See the Field Index to learn which calls use BestOfferDetails.

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

Indicates, when true, that an item is available by Best Offer.
See the Field Index to learn which calls use BestOfferEnabled.

BiddingDetails ( BiddingDetailsType ) [0..1]
This container consists of information about the buyer's bidding history on a single auction item.

Not applicable to Half.com.
See the Field Index to learn which calls use BiddingDetails.

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

Bid groups are only applicable to the Bid Assistant feature, which is a feature that has been retired. This field is scheduled to be removed from ItemType.
See the Field Index to learn which calls use BidGroupItem.

BusinessSellerDetails ( BusinessSellerDetailsType ) [0..1]
Returns the seller's information (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'. This is only applicable for sites where Business Seller options are supported.
See the Field Index to learn which calls use BusinessSellerDetails.

BuyerGuaranteePrice ( AmountType (double) ) [0..1]
For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.
See the Field Index to learn which calls use BuyerGuaranteePrice.

BuyerProtection ( see BuyerProtectionCodeType for possible values ) [0..1]
Flag to indicate an item's eligibility for the PayPal Purchase Protection program. This field is only returned if 'true'. If this field is not returned, the item is not eligible for PayPal Purchase Protection. For more information on items that are eligible for PayPal Purchase Protection, see the PayPal Purchase Protection help page.

Not applicable to Half.com.
See the Field Index to learn which calls use BuyerProtection.

BuyerRequirementDetails ( BuyerRequirementDetailsType ) [0..1]
When this container is present in an AddItem or AddFixedPriceItem call, all buyer requirements for the resulting listing are set by this container. Furthermore, individual buyer requirements cannot be modified or added when including this container in a ReviseItem call. The ReviseItem call needs to provide the entire set of buyer requirements to modify or add any of the requirements. Unless otherwise specified, most buyer requirements are only returned if the caller is the seller. All global My eBay Buyer Requirements are overridden by the contents of this container. This means that buyer requirements set in My eBay cannot be combined with buyer requirements included in this container.

Not applicable to Half.com.
See the Field Index to learn which calls use BuyerRequirementDetails.

BuyerResponsibleForShipping ( boolean ) [0..1]
Applicable for listings in vehicle categories on the US eBay Motors site and eBay Canada site. (No business effect if specified for other categories or sites, as the Web site will not display the information to buyers.) If true, the buyer is responsible for vehicle pickup or shipping. If false, specify vehicle shipping arrangements in the item description. Default is true. (The description can also include vehicle shipping arrangements when this value is true.) If the item has bids or ends within 12 hours, you cannot modify this flag. Do not specify ShippingDetails.ShippingServiceOptions for vehicle listings.

If true and the listing is on the US eBay Motors site, and you want the listing to be visible on the eBay Canada site, set Item.ShipToLocations to CA. If true and the listing is on the eBay Canada site , and you want your listing to be visible on the US eBay Motors site, set Item.ShipToLocations to US.

Not applicable to Half.com.
See the Field Index to learn which calls use BuyerResponsibleForShipping.

BuyItNowPrice ( AmountType (double) ) [0..1]
For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing.

There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid.

This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings.

Once an auction has bids (and the high bid exceeds the Reserve Price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not.

There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user.

To remove this value when revising or relisting an item, use DeletedField.
See the Field Index to learn which calls use BuyItNowPrice.

CategoryBasedAttributesPrefill ( boolean ) [0..1]
If this field is included in the request and set to 'true', eBay will auto-fill some of a listing's Item Specifics values based on the listing's category (or categories). Auto-filling Item Specifics based on a category is not the same as using Pre-filled Item Information based on a catalog product (see ProductListingDetails). If you set CategoryBasedAttributesPrefill to 'true', it is recommended that you also include and set the Item.CategoryMappingAllowed value to 'true', so you can be assured that your item will pick up the Item Specifics values from the correct category (categories). This field will be ignored if the category does not support auto-filling attributes.

If you also pass in Item Specifics through the Item.ItemSpecifics container in the request, these values will override any auto-filled values for the same Item Specifics. Once you have overridden the value of an auto-filled Item Specifics for a given listing, eBay will not auto-fill it on subsequent ReviseItem requests (even if you remove the overridden value from the Item Specific in the ItemSpecifics container).

Not applicable to Half.com.
See the Field Index to learn which calls use CategoryBasedAttributesPrefill.

CategoryMappingAllowed ( boolean ) [0..1]
Controls how eBay handles cases in which an Category ID specified in PrimaryCategory and/or SecondaryCategory no longer exists in the current category structure: If you pass a value of 'true' in CategoryMappingAllowed, eBay will look up the current category ID that is mapped to the same category and use the new Category ID for the listing (if any). The new Category ID will be returned in the response as CategoryID (for the primary category) or Category2ID (for the secondary category). If CategoryMappingAllowed is not set or contains a value of 'false' (the default), an error will be returned if a specified Category ID no longer exists.

Not applicable to Half.com.
See the Field Index to learn which calls use CategoryMappingAllowed.

CeilingPrice ( AmountType (double) ) [0..1]
This value sets the maximum price threshold for a seller's product price in a fixed-price listing. Regardless of the product price on Amazon or eBay Value Box, the seller's product price will not be raised higher than this dollar value.

This value is only applicable to sellers using the Dynamic Pricing API, and if a dynamic pricing rule is assigned to the listing's product. If this field is not specified through the Dynamic Pricing API, an eBay system-level threshold is used to avoid any undesirable results.
See the Field Index to learn which calls use CeilingPrice.

Charity ( CharityType ) [0..1]
Identifies a Giving Works listing and the benefiting nonprofit charity organization selected by the charity seller (if any). If specified, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods).

When you revise an item, you can add a charity to a non-charity listing, but you cannot remove or change the charity designation. The rules for adding a charity to a listing depend on the listing type. For an auction listing, you can revise an item to add a charity if there are more than 12 hours left for the listing (whether or not the item has bids). For a fixed-price listing, you can revise an item to add a charity if there are more than 12 hours left for the listing, and the item has not been sold.

When you relist an item, use DeletedField to remove charity information.

Not applicable to Half.com.
See the Field Index to learn which calls use Charity.

ClassifiedAdPayPerLeadFee ( AmountType (double) ) [0..1]
Not used by any call.

The pay-per-lead feature is no longer available, and this field is scheduled to be removed from the WSDL.
See the Field Index to learn which calls use ClassifiedAdPayPerLeadFee.

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

This field is not returned by any Trading API calls, and will be deprecated soon.
See the Field Index to learn which calls use ConditionDefinition.

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

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

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

Note: The ConditionDescription field is optional For Add/Revise/Relist API calls. However, this field may become required in some categories starting with the Spring 2013 Seller Release.
ConditionDescription is currently supported on the eBay US and US eBay Motors (0), UK (3), CA (2), CAFR (210), AU (15), AT (16), BEFR (23), BENL (123), FR (71), DE (77), IT (101), NL (146), ES (186), CH (193), IE (205) and PL (212) sites.
The ConditionDescription field is returned by GetItem (and other related calls that return the Item object) if a condition description is specified in the listing.
See the Field Index to learn which calls use ConditionDescription.

ConditionDisplayName ( string ) [0..1]
The human-readable label for the item condition. Display names are localized for the site on which they're listed (not necessarily the site on which they're viewed).

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

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

Only returned when the seller specified ConditionID in their listing.
See the Field Index to learn which calls use ConditionDisplayName.

ConditionID ( int ) [0..1]
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 multi-quantity fixed price listings. (If a multi-quantity 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.
See the Field Index to learn which calls use ConditionID.

Country ( see CountryCodeType for possible values ) [0..1]
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').
See the Field Index to learn which calls use Country.

CrossBorderTrade ( string ) [0..*]
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.
See the Field Index to learn which calls use CrossBorderTrade.

CrossPromotion ( CrossPromotionsType ) [0..1]
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.
See the Field Index to learn which calls use CrossPromotion.

Currency ( see CurrencyCodeType for possible values ) [0..1]
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.
See the Field Index to learn which calls use Currency.

Description ( string ) [0..1]
This field is used by the seller to provide a 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.

This field is required for all listings except when creating a listing using an eBay catalog product (Item.ProductListingDetails container).

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 set to '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 the attributeLabel attribute set to 'Notes' to specify a brief description or note to the buyer.)
See the Field Index to learn which calls use Description.

DescriptionReviseMode ( see DescriptionReviseModeCodeType for possible values ) [0..1]
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.
See the Field Index to learn which calls use DescriptionReviseMode.

DisableBuyerRequirements ( boolean ) [0..1]
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.
See the Field Index to learn which calls use DisableBuyerRequirements.

DiscountPriceInfo ( DiscountPriceInfoType ) [0..1]
This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price (MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings. STP is available on the US, 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.
See the Field Index to learn which calls use DiscountPriceInfo.

DispatchTimeMax ( int ) [0..1]
Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. 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 field to a positive integer value indicating the number of days. For a list of allowed values on each eBay site, use GeteBayDetails with DetailName set to DispatchTimeMaxDetails. (Typical values are 0, 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 when it is freight shipping. For example, when ShippingService=Pickup or ShipToLocations=None, then DispatchTimeMax is not required.

A DispatchTimeMax value of 0 indicates same day handling for an item. In this case, the seller's shipping commitment depends on the order cut off time set in the seller's user preferences. This defaults to 2:00 PM local time on most sites, which can be overridden by using SetUserPreferences to set DispatchCutoffTimePreference.CutoffTime for the eBay site on which the item is listed. For orders placed (and cleared payment received) before the local order cut off time, the item must be shipped by the end of the current day. For orders completed on or after the order cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays).

Note: If a same day shipping carrier is selected, and the carrier delivers on one or both weekend days, sellers on the eBay US site are assumed to be open for business on the same days, and those days will be used when calculating total shipping time. 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 0 or 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 same day or 1-day handling (DispatchTimeMax=0 or 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 Becoming a Top Rated Seller and qualifying for Top Rated Plus 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.
See the Field Index to learn which calls use DispatchTimeMax.

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

The distance used in a proximity search distance calculation.

Not applicable to Half.com.
See the Field Index to learn which calls use Distance.

eBayNotes ( string ) [0..1]
Returns a note from eBay displayed below items in the user's My eBay account.

Not applicable to Half.com.
See the Field Index to learn which calls use eBayNotes.

eBayNowAvailable ( boolean ) [0..1]
This boolean field will be returned as 'true' if the item is available for eBay Now delivery. However, buyers should realize that they must be in an area where eBay Now delivery is available. As of April 2014, eBay Now has been launched on the San Francisco Penisula (from San Francisco to San Jose), in Chigago, in Dallas, and in the New York City boroughs of Manhattan, Brooklyn, and Queens.
See the Field Index to learn which calls use eBayNowAvailable.

eBayNowEligible ( boolean ) [0..1]
This field is used in Add/Revise/Relist calls to enable the listing for eBay Now delivery. To enable the listing for eBay Now delivery, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the eBay Now delivery feature to list an item that is eligible for eBay Now delivery. This field will be ignored if the seller is not eligible to list eBay Now products.

This field will be returned as 'true' in GetSellerList if the item is enabled for eBay Now delivery.
See the Field Index to learn which calls use eBayNowEligible.

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

This field will be returned as 'true' in GetItem if the item is eligible for the "Click and Collect" feature. With the 'Click and Collect' feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The "Click and Collect" feature is only available to UK sellers. UK buyers should realize that they must be in an area where "Click and Collect" is available. This field is not returned if 'false'.
See the Field Index to learn which calls use EligibleForPickupDropOff.

ExtendedSellerContactDetails ( ExtendedContactDetailsType ) [0..1]
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.
See the Field Index to learn which calls use ExtendedSellerContactDetails.

ExternalProductID ( ExternalProductIDType ) [0..1]
This field will be removed in a future release. New applications should use ProductListingDetails instead.
See the Field Index to learn which calls use ExternalProductID.

FloorPrice ( AmountType (double) ) [0..1]
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.
See the Field Index to learn which calls use FloorPrice.

FreeAddedCategory ( CategoryType ) [0..1]
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.
See the Field Index to learn which calls use FreeAddedCategory.

GetItFast ( boolean ) [0..1]
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 applicable to Half.com.
See the Field Index to learn which calls use GetItFast.

GiftIcon ( int ) [0..1]
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.
See the Field Index to learn which calls use GiftIcon.

GiftServices ( see GiftServicesCodeType for possible values ) [0..*]
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.
See the Field Index to learn which calls use GiftServices.

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

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.
See the Field Index to learn which calls use GroupCategoryID.

HideFromSearch ( boolean ) [0..1]
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.
See the Field Index to learn which calls use HideFromSearch.

HitCount ( long ) [0..1]
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.
See the Field Index to learn which calls use HitCount.

HitCounter ( see HitCounterCodeType for possible values ) [0..1]
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.
See the Field Index to learn which calls use HitCounter.

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

This field is for internal or future use.
See the Field Index to learn which calls use IgnoreQuantity.

IncludeRecommendations ( boolean ) [0..1]
If this field is included and set to 'true' in the request of an Add/Revise/Relist/Verify API call, the call response will include any listing recommendations that will help the seller improve the quality of the listing. The type of listing recommendations include the following:
  • Category - if eBay determines that an item has been miscategorized (or placed into a non-optimal category), one to three recommendation containers will be returned in the response indicating one to three categories that would be better matches for the item than the current listing category. This recommendation type is currently only supported on the US and UK sites;
  • ConditionDescription - this recommendation type advises the seller that the used item listing could be improved if a Condition Description was added to the listing. Condition Descriptions may help potential buyers make a decision on whether or not they want to buy the used item, and may increase the seller's chances of receiving positive feedback from a buyer;
  • ItemSpecifics - this recommendation type advises the seller that the listing is missing one or more required or recommended Item Specifics name/value pairs;
  • eTRS - this recommendation type advises the seller that the listing is not meeting a specific Top-Rated Plus listing requirement, such as same-day or 1-day handling or a 14-day (or longer) Money Back Return Policy;
  • ItemSpecifics - this recommendation type advises the seller that the listing is missing one or more required or recommended Item Specifics name/value pairs;
  • Picture - this recommendation type advises the seller that a specific picture in the listing is not meeting a specific picture quality requirement;
  • Price - this recommendation type provides a recommended price and/or a recommended price range for auction and fixed-price listings. These price recommendation values are based on similar items that have recently sold on eBay. Along with pricing recommendations, a recommended listing format (auction vs. fixed-price) is also returned. This recommendation type is currently only supported on the US, UK, and DE sites;
  • Title - this recommendation type provides guidance on forming an effective listing title. The Listing Recommendation API will suggest that the listing title is missing valuable keywords, missing recommended Item Specifics, or has keywords that should not be there since it misrepresents the item. The keywords or Item Specifics are called out in the response. This recommendation type is currently only supported on the US, UK, DE, and AU sites; and
  • UPC - this recommendation type advises the seller that a product code (like a UPC or ISBN) is available to use to create a higher-quality listing.< /li>
Note: Although the GSP listing recommendation type is available through the Listing Recommendation API, this recommendation type is not yet supported in the Trading API.
See the Field Index to learn which calls use IncludeRecommendations.

IntegratedMerchantCreditCardEnabled ( boolean ) [0..1]
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).
See the Field Index to learn which calls use IntegratedMerchantCreditCardEnabled.

InventoryTrackingMethod ( see InventoryTrackingMethodCodeType for possible values ) [0..1]
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.
See the Field Index to learn which calls use InventoryTrackingMethod.

IsIntermediatedShippingEligible ( boolean ) [0..1]
If true, sellers can offer eBay's Global Shipping Program when listing the specified item.
See the Field Index to learn which calls use IsIntermediatedShippingEligible.

ItemCompatibilityCount ( int ) [0..1]
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.
See the Field Index to learn which calls use ItemCompatibilityCount.

ItemCompatibilityList ( ItemCompatibilityListType ) [0..1]
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 GetCategoryFeatures with the "CompatibilityEnabled" feature ID to determine which categories support parts compatibility by application.

Note: Only valid parts compatibility name-value pairs will be added to the listing. Any invalid parts 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: ItemCompatibilityList is returned only if:
  • The seller included item compatibility in the listing.
  • The item compatibility details were specified manually; that is, they do not correspond to an eBay catalog product. (To retrieve compatibility details that do correspond to eBay catalog products, use the eBay Product API's getProductCompatibilities call.)
  • IncludeItemCompatibilityList is set to true in the GetItem request
  • .
See the Field Index to learn which calls use ItemCompatibilityList.

ItemID ( ItemIDType (string) ) [0..1]
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 Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base.
See the Field Index to learn which calls use ItemID.

ItemPolicyViolation ( ItemPolicyViolationType ) [0..1]
Specifies the details of policy violations if the item was administratively canceled.
See the Field Index to learn which calls use ItemPolicyViolation.

ItemSpecifics ( NameValueListArrayType ) [0..1]
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.)
See the Field Index to learn which calls use ItemSpecifics.

LeadCount ( int ) [0..1]
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.
See the Field Index to learn which calls use LeadCount.

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

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.
See the Field Index to learn which calls use LimitedWarrantyEligible.

ListingCheckoutRedirectPreference ( ListingCheckoutRedirectPreferenceType ) [0..1]
Container consisting of the ProStores store name and user name.
See the Field Index to learn which calls use ListingCheckoutRedirectPreference.

ListingDesigner ( ListingDesignerType ) [0..1]
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.
See the Field Index to learn which calls use ListingDesigner.

ListingDetails ( ListingDetailsType ) [0..1]
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.
See the Field Index to learn which calls use ListingDetails.

ListingDuration ( token ) [0..1]
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).
See the Field Index to learn which calls use ListingDuration.

ListingEnhancement ( see ListingEnhancementsCodeType for possible values ) [0..*]
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.
See the Field Index to learn which calls use ListingEnhancement.

ListingSubtype2 ( see ListingSubtypeCodeType for possible values ) [0..1]
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.
See the Field Index to learn which calls use ListingSubtype2.

ListingType ( see ListingTypeCodeType for possible values ) [0..1]
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).

See the Field Index to learn which calls use ListingType.

LiveAuction ( boolean ) [0..1]
This field should be included and set to 'true' in Add/Revise/Relist calls to enable the listing as a "Live Auction". The Live Auctions feature will allow real-time bidding on eBay for items that are up for bidding at a live auction (physical location).

To enable a "Live Auction" listing through an Add call, the following things must be true:
  • The eBay site must support Live Auction listings.
  • The seller must be eligible to list Live Auction items.
  • The Item.ListingType value should be set to 'Chinese' (auction format).
  • The Item.ListingDuration value should be set to 'Days_3', 'Days_5', 'Days_7', or 'Days_10'.
With Live Auction listings, the seller can:
  • set the ShippingServiceOptions.ShippingService field to 'LocalPickup', which will allow the buyer to pick up the item at the auction house/auction location. Other shipping service options will also be allowed. However, if 'LocalPickup' is used, the shipping type must be set to flat-rate shipping (ShippingDetails.ShippingType=Flat).
  • Create the listing without any electronic payment method. To do this, the seller would pass in 'PaymentSeeDescription' in one Item.PaymentMethods, and then would describe the payment instructions/arrangement in the Item.Description field.
  • Use the Item.ScheduleTime field to set the auction start time to a date in the future. The time between the listing creation time and the auction start time can be used to allow interested eBay users to register for the Live Auction event.


eBay users will be required to register for Live Auction events if they wish to bid on a Live Auction item. Once they are registered, they will also be allowed to add the Live Auction item to their Watch List. If the Live Auction listing accepts an electronic form of payment (like PayPal), the winning bidder can add the Live Auction item to the shopping cart and use eBay checkout.

The LiveAuction boolean field will only be returned in GetItem if 'true'.

Note: The Live Auction feature is scheduled to start ramping up for eligible eBay US sellers (site ID=0) in late August 2014. For the eBay UK (site ID=3), eBay France (site ID=71), and eBay Hong Kong (site ID=201), the Live Auction feature is scheduled to start ramping up for eligible sellers on those sites in late September 2014.
See the Field Index to learn which calls use LiveAuction.

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

Indicates, when true, that an item is available locally.
See the Field Index to learn which calls use LocalListing.

Location ( string ) [0..1]
Indicates the geographical location of the item (along with Country) to be displayed on eBay listing pages. 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.

Note: If you specify both Location and PostalCode, and eBay can determine a location that corresponds to the postal code, the postal code-derived location will be used for the listing. 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.
See the Field Index to learn which calls use Location.

LocationDefaulted ( boolean ) [0..1]
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.
See the Field Index to learn which calls use LocationDefaulted.

LookupAttributeArray ( LookupAttributeArrayType ) [0..1]
No longer applicable to any category.
See the Field Index to learn which calls use LookupAttributeArray.

LotSize ( int ) [0..1]
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.
See the Field Index to learn which calls use LotSize.

MechanicalCheckAccepted ( boolean ) [0..1]
Indicates whether the seller allows the bidder to request mechanical inspection services from RAC. For Car category listings on the UK site.
See the Field Index to learn which calls use MechanicalCheckAccepted.

MotorsGermanySearchable ( boolean ) [0..1]
If this field is included and set to 'true' for a motor vehicle listing on the Germany site, the seller's motor vehicle listing will also appear on the mobile.de partner site. This field is only applicable to the eBay Germany site and only applicable when listing a motor vehicle on that site. If this field is used in any other situation, it is ignored.

Listing on the mobile.de is considered a listing upgrade so the seller will be charged a listing upgrade fee.

Not applicable to Half.com.
See the Field Index to learn which calls use MotorsGermanySearchable.

NewLeadCount ( int ) [0..1]
Specifies the number of new leads (unanswered emails) buyers have posted about the item.
See the Field Index to learn which calls use NewLeadCount.

OutOfStockControl ( boolean ) [0..1]
When this field is set to 'true' the item is hidden from search when the quantity goes to 0 (zero) but the listing is kept alive. Using an OutOfStockControl flag in an Add/Revise/Relist call, a seller can keep a Fixed-Price GTC (Good 'Til Canceled) listing alive even when the "quantity available" value goes to 0 (zero). While the "quantity available" value is 0, the listing would be hidden from eBay search, and if that item was specifically searched for with GetItem (or related call), the element HideFromSearch would be returned as 'true' and ReasonHideFromSearch would be returned as 'OutOfStock'.

This is useful for a seller who is waiting for additional stock of an item with the same ItemID. Instead of ending the listing and then recreating it when the inventory arrives, they can use this flag to hide the listing. Then when they have the item available they can use the Revise calls to update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields) and the listing would appear again.

Using this flag also has the following benifits.
  • Increasing SEO (search engine optimization) -- Since the item is a long running item this increases the chances that it will be indexed by popular search engines.
  • Making merchandizing and inventory management easier
    • Due to the 1:1 mapping of the SKU and ItemID mapping, the merchant doesn't have to refer to multiple ItemIDs to get a count of how much they have in stock, what was sold, etc.
    • Since the listing stays alive, the sales history is retained.
Things to Note:
  • This feature is best suited for Business to Consumer sellers and is available only through the API.
  • OutOfStockControl is set at the item level. So you can set this flag for existing listings using a Revise call and can include it in Add calls.
  • Once this flag is set to 'true' you cannot change it. To remove it, end the item and relist it by setting the OutOfStockControl field to 'false'.
  • When OutOfStockControl is set to 'true', you can set the quantity of the item to zero. When OutOfStockControl is set to 'false' you cannot set the quantity to zero.
  • On a single SKU item, with OutOfStockControl set to 'true' and the quantity is zero, the item does not appear in the SRP (Search Results Page). If a user has the ItemID, they can go to the VIP (View Item Page) directly. On this page, the Buy It Now and Add to cart buttons are gone, and there is a label showing that the item is out of stock.
  • On a multi-SKU item with OutOfStockControl set to 'true', if at least one variation has stock, the item will appear on the SRP. Variations with zero quantity will be shown as 'out of stock' on the VIP. When all of the variations have zero quantity, the item will not appear on the SRP. However, if a user has the ItemID, they can go to the VIP directly. In that case, all the variations are greyed out, the Buy It Now and Add to cart buttons are gone, and there is a label showing that the item is out of stock.
  • Variations: Changing the quantity to zero of variations behaves differently depending on the value of OutOfStockControl. The following shows the behavior when setting the quantity of a variation to zero. In this example there are three variations; A with a quantity of 5, B with a quantity of 3, and C with a quantity of 1 and there have been no sales of any of these variations.

    Variation Quantity Set to 0OutOfStockControl = falseOutOfStockControl = true
    A Variation A is deleted. Variation is retained. Since at least one variation has stock, this variation will show up on the SRP (Search Results Page). On the VIP (View Item Page) it will be shown as 'Out of Stock'.
    B Variation B is deleted. Variation is retained. Since at least one variation has stock, this variation will show up on the SRP. On the VIP it will be shown as 'Out of Stock'.
    C You receive an error because you cannot set the last variation to quantity zero. The variation is retained and all variations will be shown as 'Out of Stock' on the VIP. The item will not appear on the SRP.
  • If you want to delete a variation for an item that has OutOfStockControl set to 'true', you will need to set the Item.Variations.Variation.Delete field to 'true'.


IMPORTANT: When an item is hidden the listing is still alive. That means the Good 'Til Cancelled automatic renewal will continue every 30 days AND the listing fees will be charged. This is best suited for long running items where inventory can be replace in a reasonable time.

See the Field Index to learn which calls use OutOfStockControl.

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

Not currently operational.
See the Field Index to learn which calls use PartnerCode.

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

Not currently operational.
See the Field Index to learn which calls use PartnerName.

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

PaymentDetails ( PaymentDetailsType ) [0..1]
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).
See the Field Index to learn which calls use PaymentDetails.

PaymentMethods ( see BuyerPaymentMethodCodeType for possible values ) [0..*]
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>
<PayPalEmailAddress>mypaypalemail@ebay.com</PayPalEmailAddress>

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.
See the Field Index to learn which calls use PaymentMethods.

PayPalEmailAddress ( string ) [0..1]
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.
See the Field Index to learn which calls use PayPalEmailAddress.

PickupInStoreDetails ( PickupInStoreDetailsType ) [0..1]
This container is used in Add/Revise/Relist calls to enable the listing for In-Store Pickup or Click and Collect.

This container is returned in GetItem, GetSellerList, and GetItemShipping if In-Store Pickup or Click and Collect is set for the listing.

Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. The Click and Collect feature is only available to large merchants selling on the eBay UK site.
See the Field Index to learn which calls use PickupInStoreDetails.

PictureDetails ( PictureDetailsType ) [0..1]
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. It is required that all listings have at least one picture.


Not applicable to Half.com.
See the Field Index to learn which calls use PictureDetails.

PostalCode ( string ) [0..1]
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.

eBay derives a geographical location from the postal code to display on eBay listing pages. If you do not specify PostalCode, you must specify Item.Location.

Note: If you specify both PostalCode and Location, and eBay can determine a location that corresponds to the postal code, the postal code-derived location will be used for the listing. Not applicable to Half.com.
See the Field Index to learn which calls use PostalCode.

PostCheckoutExperienceEnabled ( boolean ) [0..1]
Reserved for future use.
See the Field Index to learn which calls use PostCheckoutExperienceEnabled.

PrimaryCategory ( CategoryType ) [0..1]
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.

Note: For some large merchants, there are no limitations on when the primary or secondary listing categories for a fixed-price listing can be revised, even when the listing has had transactions or is set to 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 the Field Index to learn which calls use PrimaryCategory.

PrivateListing ( boolean ) [0..1]
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.
See the Field Index to learn which calls use PrivateListing.

PrivateNotes ( string ) [0..1]
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.)
See the Field Index to learn which calls use PrivateNotes.

ProductListingDetails ( ProductListingDetailsType ) [0..1]
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.

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, 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.
See the Field Index to learn which calls use ProductListingDetails.

ProxyItem ( boolean ) [0..1]
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.
See the Field Index to learn which calls use ProxyItem.

Quantity ( int ) [0..1]
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, RelistFixedPriceItem, and VerifyRelistItem: Previously in RelistItem, RelistFixedPriceItem, and VerifyRelistItem the Quantity field retained its value from the previous listing unless you specifically changed it by including the field in a relist call and giving it a new value. And this value was often not accurate with the quantity that was really still available for purchase and it was often out of synch with the QuantityAvailable value that is returned with the GetMyeBaySelling call. As of March 13, 2014, this behavior has been changed in the following manner:
  • For a listing that has ended with an available quantity greater than zero, the Quantity value of the newly relisted item is set to the actual QuantityAvailable value (see the GetMyeBaySelling call) when the previous listing ended.
  • For listings that ended with an available quantity of zero, the relisted item will retain the Quantity value that was passed in at creation time of the previous listing.
So, if you are relisting an item that had an available quantity of zero when the listing ended, we strongly recommend that you pass in the correct available quantity through the Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value.

You can set the Quantity to 0 (zero) and keep the listing active if OutOfStockControl is set to 'true'.

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.
See the Field Index to learn which calls use Quantity.

QuantityAvailable ( int ) [0..1]
Specifies how many of a certain item are available.

Not applicable to Half.com.
See the Field Index to learn which calls use QuantityAvailable.

QuantityAvailableHint ( see QuantityAvailableHintCodeType for possible values ) [0..1]
Indicates the type of message that will be returned describing the quantity available for the item.
See the Field Index to learn which calls use QuantityAvailableHint.

QuantityInfo ( QuantityInfoType ) [0..1]
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.
See the Field Index to learn which calls use QuantityInfo.

QuantityRestrictionPerBuyer ( QuantityRestrictionPerBuyerInfoType ) [0..1]
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.
See the Field Index to learn which calls use QuantityRestrictionPerBuyer.

QuantityThreshold ( int ) [0..1]
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.
See the Field Index to learn which calls use QuantityThreshold.

QuestionCount ( long ) [0..1]
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0.

Not applicable to Half.com.
See the Field Index to learn which calls use QuestionCount.

ReasonHideFromSearch ( see ReasonHideFromSearchCodeType for possible values ) [0..1]
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.
See the Field Index to learn which calls use ReasonHideFromSearch.

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

No longer used by any site.
See the Field Index to learn which calls use RegionID.

Relisted ( boolean ) [0..1]
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.
See the Field Index to learn which calls use Relisted.

RelistLink ( boolean ) [0..1]
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.
See the Field Index to learn which calls use RelistLink.

RelistParentID ( long ) [0..1]
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.
See the Field Index to learn which calls use RelistParentID.

ReservePrice ( AmountType (double) ) [0..1]
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.
See the Field Index to learn which calls use ReservePrice.

ReturnPolicy ( ReturnPolicyType ) [0..1]
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.
See the Field Index to learn which calls use ReturnPolicy.

ReviseStatus ( ReviseStatusType ) [0..1]
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.
See the Field Index to learn which calls use ReviseStatus.

ScheduleTime ( dateTime ) [0..1]
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: Why scheduled time is sometimes getting reset.

Not applicable to Half.com.
See the Field Index to learn which calls use ScheduleTime.

SearchDetails ( SearchDetailsType ) [0..1]
Not used by any call.

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.
See the Field Index to learn which calls use SearchDetails.

SecondaryCategory ( CategoryType ) [0..1]
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.

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 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, 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.

Note: For some large merchants, there are no limitations on when the primary or secondary listing categories for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. 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.
See the Field Index to learn which calls use SecondaryCategory.

Seller ( UserType ) [0..1]
Container for information about this listing's seller.

Not applicable to Half.com.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.
See the Field Index to learn which calls use Seller.

SellerContactDetails ( AddressType ) [0..1]
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
See the Field Index to learn which calls use SellerContactDetails.

SellerInventoryID ( string ) [0..1]
Unique identifier for a Half.com item. Must be an alphanumeric value (with no symbols) that is unique across the seller's active (unsold) inventory on Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. Only returned from GetOrders if the seller specified a value when the item was listed. You cannot revise this field.

Not applicable to eBay.com listings.
See the Field Index to learn which calls use SellerInventoryID.

SellerProfiles ( SellerProfilesType ) [0..1]
Root container consisting of references to one or more Business Policies profiles. Exactly one Payment Profile, one Shipping Profile, and one Return Policy Profile may be applied to the listing.
See the Field Index to learn which calls use SellerProfiles.

SellerProvidedTitle ( string ) [0..1]
A descriptive free-text title for a US or CA eBay Motors vehicle listing. This title appears below eBay's pre-filled listing title on the View Item page (not at the top of the View Item page). It's also appended to the listing title in search results (like a subtitle) on the US eBay Motors site. Keywords in this title help buyers find or distinguish your listing.

Applicable to listings in US eBay Motors Cars and Trucks, Motorcycle, and some of the Powersport, Boats and RV campers categories; or to Cars and Trucks listings on CA eBay Motors.

This replaces the older US and Canada eBay Motors Subtitle attribute (attribute ID 10246).

Not applicable to Half.com.
See the Field Index to learn which calls use SellerProvidedTitle.

SellerVacationNote ( string ) [0..1]
The seller is on vacation (as determined by the seller has chosen to add a message to listed items while on vacation.

Not applicable to Half.com.
See the Field Index to learn which calls use SellerVacationNote.

SellingStatus ( SellingStatusType ) [0..1]
Various details about the current status of the listing, such as the current number of bids and the current high bidder.

Not applicable to Half.com.
See the Field Index to learn which calls use SellingStatus.

ShippingDetails ( ShippingDetailsType ) [0..1]
The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs.

New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired.

For Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout.

IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing.
Shipping details are not applicable to Real Estate listings and Half.com.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.)
See the Field Index to learn which calls use ShippingDetails.

ShippingPackageDetails ( ShipPackageDetailsType ) [0..1]
Container consisting of dimension and size details related to a shipping package in which an item will be sent. The information in this container is applicable if the seller is using calculated shipping or flat rate shipping using shipping rate tables with weight surcharges. This container is only returned in the "Get" calls if specified for the item.
See the Field Index to learn which calls use ShippingPackageDetails.

ShippingServiceCostOverrideList ( ShippingServiceCostOverrideListType ) [0..1]
This container is used when the seller wants to override the flat shipping costs for all domestic and/or all international shipping services defined in the Business Policies shipping profile referenced in the SellerProfiles.SellerShippingProfile.ShippingProfileID field. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services.

A ShippingServiceCostOverrideList.ShippingServiceCostOverride container is required for each domestic and/or international shipping service that is defined in the domesticShippingPolicyInfoService and intlShippingPolicyInfoService containers of the Business Policies shipping profile.

Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each ShippingServiceCostOverrideList.ShippingServiceCostOverride container will not change the shipping costs defined for the same shipping services in the Business Policies shipping profile.
See the Field Index to learn which calls use ShippingServiceCostOverrideList.

ShippingTermsInDescription ( boolean ) [0..1]
Indicates whether details about shipping costs and arrangements are specified in the item description.

Not applicable to Half.com.
See the Field Index to learn which calls use ShippingTermsInDescription.

ShipToLocations ( string ) [0..*]
An international location or region to which the seller is willing to ship, regardless of shipping service. The country of the listing site is added by eBay. Use GeteBayDetails with DetailName set to ShippingLocationDetails to determine which international locations are valid for the site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields.

Omit ShipToLocations if you want to ship only within the country of the listing site. To state that you do not wish to ship at all, set ShipToLocations to None. ReviseItem can add a ShipToLocations. On output, ShipToLocations is the collection of all input item-level ShipToLocations plus international shipping service-level ShipToLocation values.

If you have specified a region to which you will ship (such as Asia), you can use ExcludeShipToLocation to exclude certain countries within that region to where you will not ship (such as Afghanistan).

Not applicable to Half.com.
See the Field Index to learn which calls use ShipToLocations.

Site ( see SiteCodeType for possible values ) [0..1]
The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches, and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing.

When you specify Item.Site in AddItem or AddFixedPriceItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API).

Not applicable to Half.com.
See the Field Index to learn which calls use Site.

SKU ( SKUType (string) ) [0..1]
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.)

A SKU is not required to be unique, when you track listings by their ItemID (the default tracking method). A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs.

If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method.

If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing.

For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier.

Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.)

For GetMyeBaySelling, this is only returned if set.
Not applicable to Half.com.
See the Field Index to learn which calls use SKU.

SkypeContactOption ( see SkypeContactOptionCodeType for possible values ) [0..*]
Indicates the Skype contact option that the seller and buyer can use to communicate about the listing. For Skype communication to be possible, the SkypeEnabled flag must be included and set to 'true'. The seller must also have a Skype account that is linked with his or her eBay account.

More than one Skype contact option may be specified.
See the Field Index to learn which calls use SkypeContactOption.

SkypeEnabled ( boolean ) [0..1]
Specifies that Skype-related information is included with an item listing, including, for example, Skype Voice. Skype-related information provides buttons that enable potential buyers to contact sellers through Skype. Information about Skype is available at www.Skype.com. If all of the prerequisites for adding Skype buttons to listings are met (see the eBay Web Services Guide), you can make communication through Skype available in listings. SkypeEnabled must be true if SkypeID and SkypeContactOption are specified.
See the Field Index to learn which calls use SkypeEnabled.

SkypeID ( string ) [0..1]
The Skype name of the seller. Requires that SkypeEnabled is set to true. Available if the seller has a Skype account and has linked it (on the eBay site) with his or her eBay account.
See the Field Index to learn which calls use SkypeID.

StartPrice ( AmountType (double) ) [0..1]
This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For fixed-price listings: This is the fixed-price at which a buyer may purchase the item.

For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types.

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice.

For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead.

Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings.
See the Field Index to learn which calls use StartPrice.

Storefront ( StorefrontType ) [0..1]
Contains information related to the item in the context of a seller's eBay Store. Applicable for auction and fixed-price listings listed by eBay Stores sellers.

Not applicable to Half.com.
See the Field Index to learn which calls use Storefront.

SubTitle ( string ) [0..1]
Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees).

Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle.

When you revise a item, you can add, change, or remove the subtitle.

Not applicable to Half.com.
See the Field Index to learn which calls use SubTitle.

TaxCategory ( string ) [0..1]
Tax exception category code. This is to be used only by sellers who have opted into sales tax being calculated by a sales tax calculation vendor. If you are interested in becoming a tax calculation vendor partner with eBay, contact developer-relations@ebay.com.
See the Field Index to learn which calls use TaxCategory.

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

Deprecated.
See the Field Index to learn which calls use ThirdPartyCheckout.

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

Deprecated.
See the Field Index to learn which calls use ThirdPartyCheckoutIntegration.

TimeLeft ( duration ) [0..1]
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
See the Field Index to learn which calls use TimeLeft.

Title ( string ) [0..1]
Name of the item as it appears in the listing or search results. Title is required for most items. This field is only optional if you leverage Pre-filled Item Information by using the Item.ProductListingDetails or Item.ExternalProductID containers.

You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.)

For the AddItem family of calls: Not applicable to Half.com.

For ReviseItem and ReviseFixedPriceItem You can only add or change the item title if the listing has no bids (for auctions) or sales (for fixed-price listings) and the listing does not end within 12 hours.

Note: For some large merchants, there are no limitations on when the Item Title for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations.
See the Field Index to learn which calls use Title.

TopRatedListing ( boolean ) [0..1]
This field applies only to the US site, and will be returned only if the US seller qualifies as a Top-Rated Seller.

If this flag is returned for a listing, it indicates that the listing meets the new requirements for a Top-Rated Plus listing. A Top-Rated Plus listing must meet the following requirements:
  • 14-day (or longer) return policy with Money Back option
  • 1-day Handling Time or better

A Top-Rated Plus seal appears on the View Item page for qualifying listings. Top-Rated Sellers get a 20 percent discount on their Final Value Fee for all listings that qualify as Top-Rated Plus.

See eBay's Top Rated Seller Resource Center for more information about how to qualify as a Top-Rated Seller.
See the Field Index to learn which calls use TopRatedListing.

TotalQuestionCount ( long ) [0..1]
The number of questions asked about this item. Applies to eBay Motors Pro applications only.
See the Field Index to learn which calls use TotalQuestionCount.

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

With GetItem, this container is returned only when you provide IncludeItemSpecifics in the request and set it to true.

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

UpdateReturnPolicy ( boolean ) [0..1]
Flag to indicate whether the item's Return Policy has been updated as part of the revised listing.
See the Field Index to learn which calls use UpdateReturnPolicy.

UpdateSellerInfo ( boolean ) [0..1]
Specifies whether the following Business Seller fields have been updated for the item specified in the request: First Name, Last Name, Fax, Email Address, Additional Contact Information, Trade Registration Number, VAT Identification Number.
See the Field Index to learn which calls use UpdateSellerInfo.

UseRecommendedProduct ( boolean ) [0..1]
If true, and the item details in the request match a product in the eBay catalog, the matching product is used to list the item. This is like using ProductListingDetails to list an item. Applies only to catalog-enabled categories.

This feature is available to a small subset of eBay-selected sellers.

Not applicable to Half.com.
See the Field Index to learn which calls use UseRecommendedProduct.

UseTaxTable ( boolean ) [0..1]
Indicates whether the seller's tax table is to be used when applying and calculating sales tax for an order line item. A sales tax table can be created programmatically using the SetTaxTable call, or it can be created manually in My eBay's Selling Preferences. If UseTaxTable is set to true, the values contained in the seller's sales tax table will supersede the values contained in the Item.ShippingDetails.SalesTax container (if included in the request).

Not applicable to Half.com.
See the Field Index to learn which calls use UseTaxTable.

UUID ( UUIDType (string) ) [0..1]
Universally unique constraint tag. Use UUID to ensure that you only list a particular item once, particularly if you are listing many items at once. If you add an item and do not get a response, resend the request with the same UUID. If the item was successfully listed the first time, you will receive an error message for trying to use a UUID that you have already used. The error will also include the item ID for the duplicated item and a boolean value indicating whether the duplicate UUID was sent by the same application.

We recommend you use Item.UUID with calls that add item objects (for example, AddItem and RelistItem). For calls that modify an existing item, such as ReviseItem, use InvocationID instead.

The UUID can only contain digits from 0-9 and letters from A-F and must be 32 characters long. The UUID value must be unique across all item listings on all sites.

Also applicable as input to AddItem and related calls when you list items to Half.com.
See the Field Index to learn which calls use UUID.

Variations ( VariationsType ) [0..1]
Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one order line item can contain multiple items from a single variation.)

If you list in two categories, both categories must support listing with variations. See VariationsEnabled in GetCategoryFeatures to determine applicable categories.

For ReviseFixedPriceItem and RelistFixedPriceItem: Once a listing has been submitted with variations, you can't delete all the variations when you revise or relist the listing (because it would be considered a different listing). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no purchases, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0.

As a best practice, if you want to revise multiple variations in the same listing at the same time (i.e, within a very short period), use a single ReviseFixedPriceItem request and include all the variation revisions in the same request. If your application design requires you to revise each variation individually, then avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing.

For GetItem and related calls Only returned when a listing has variations.

For GetSellerList: Only returned when a listing has variations, IncludeVariations was set to true in the request, the DetailLevel was set to ReturnAll, and an applicable pagination value and time range were specified.

For GetItemTransactions Only returned in Item when a listing has variations and IncludeVariations was set to true in the request. (Also see Variation returned in Transaction for information about which variation was actually purchased.)

For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling: Only returned when a listing has variations and HideVariations was set to false or not specified in the request.
See the Field Index to learn which calls use Variations.

VATDetails ( VATDetailsType ) [0..1]
Container for eBay's VAT features. A business seller can choose to offer an item exclusively to bidders and buyers that also represent businesses. Only applicable when the item is listed in a B2B-enabled category (on a site that supports B2B business features).

Note: The India site (Global ID 203) does not accept VAT values in item listings. If you submit an item to the India site with a VAT value, eBay generates a warning message that indicates the listing was accepted, but the VAT value was removed. To include the VAT, relist the item with a Price value that includes the VAT. Sellers are solely responsible for compliance relating to tax legislation in India.

Not applicable to Half.com.
See the Field Index to learn which calls use VATDetails.

VIN ( string ) [0..1]
Vehicle Identification Number, which is a unique serial number for a motor vehicle.

Applicable to listings in US eBay Motors Cars and Trucks (6001), Motorcycles (6024), Commercial Trucks (63732), RVs and Campers (50054), ATVs (6723), Snowmobiles (42595), and UTVs (173665); and to Cars and Trucks listings in CA, CAFR and AU eBay Motors. For vehicle categories that do not use VIN, call GetCategorySpecifics to determine applicable custom item specifics (such as "Hull ID Number" for Boats).

For the US, CA, and CAFR eBay Motors sites, required for cars and trucks from model year 1981 and later. (The US developed national standards for VIN values as of 1981.)

For the eBay Australia site, required for vehicles from model year 1989 or later. For the eBay Australia site, only appears on the View Item page if you also specify the date of first registration in the listing's item specifics.

Appears in the VIN field in the Item Specifics section of eBay's View Item page.

Not applicable to Half.com.
See the Field Index to learn which calls use VIN.

VINLink ( string ) [0..1]
Link to the Vehicle History Report for the vehicle whose VIN was specified in Item.VIN. If no vehicle history report is available, eBay may instead show a plain-text copy of the VIN.

Applicable to listings in US eBay Motors Cars and Trucks, Motorcycle, and some Powersport, Boats and RV campers categories; and to Cars and Trucks listings in CA, CAFR and AU eBay Motors.

For the eBay Australia site, only appears on the View Item page if you specify Item.VIN and you also specify the date of first registration in the listing's item specifics.

Not applicable to Half.com.
See the Field Index to learn which calls use VINLink.

VRM ( string ) [0..1]
Vehicle Registration Mark, which is a unique identifier for a motor vehicle.

Applicable to listings in UK eBay Motors Cars and Trucks, Motorcycle, and some Powersport categories.

Appears as a VRM field in the Item Specifics section of eBay's View Item page. On the View Item page, the VRM value is masked (i.e., only a portion of the value is shown to users). In the GetItem response, the VRM is only returned if the call is made by the seller (i.e., the AuthToken is associated with the vehicle's seller).

Not applicable to Half.com.
See the Field Index to learn which calls use VRM.

VRMLink ( string ) [0..1]
Link to the Vehicle History Report for the vehicle whose VRM was specified in Item.VRM. The report is visible to all users. If no vehicle history report is available, eBay may instead show a plain-text copy of the masked VRM.

Applicable to listings in UK eBay Motors Cars and Trucks, Motorcycle, and some Powersport categories.

Not applicable to Half.com.
See the Field Index to learn which calls use VRMLink.

WatchCount ( long ) [0..1]
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0.

Not applicable to Half.com.
See the Field Index to learn which calls use WatchCount.

Copyright © 2005–2014 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.