eBay Trading API
Call Reference Version 579

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. ApplicationData is not applicable to Half.com. For Half.com listings, use SellerInventoryID instead.

Different Buyer protection schemes and the various status associated with each one of them.

Multiple Item Shipping Discount. Seller specifies as input when listing, re-listing, or revising an item to indicate whether a shipping discount is to be applied when the buyer pays for the item in the checkout process and the item's transaction is combined with other transactions into an order. Returned with retrieved item data, indicating a shipping discount is applicable.

Not returned by GetItem (see Item.ShippingDetails.ShippingDiscount instead).

Not applicable to Half.com.

Used to specify the item condition in AddItem. Only applicable to Half.com (not eBay listings). You can revise this property for Half.com listings. For Half.com, AddItem does not use the same Attributes format as eBay's Item Specifics.

Not returned in GetItem. See AttributeSetArray instead.

Item Specifics (such as new or used condition) in a listing. Item Specifics (attributes) describe category-specific aspects or features of an item in a standardized way. Carries one or more instances of AttributeSet in a list. For ID-based attributes in general, an item will be associated with no more than two full attribute sets (one for the primary category and one for the secondary category). For some international sites, an item can specify additional site-wide attribute sets.

Please note that AttributeSetArray does not support the new "custom Item Specifics" model. See the ItemSpecifics node instead.

For the AddItem family of calls: Some categories (such as Event Tickets and US Real Estate) require Item Specifics. See the eBay Web Services Guide links below for information on working with Item Specifics. Use GetCategory2CS and GetAttributesCS to determine when attributes are required for a category. Also use attributes to specify the item condition and/or return policy.

For a listing to be eligible for eBay Express, the item condition is required in most cases. Use GetCategoryFeatures to determine which categories are exempt from this requirement. See the eBay Web Services Guide links below for details.

For ReviseItem only: When you revise a listing, if the listing has bids and ends within 12 hours, you cannot change or add attributes. If the listing has bids but ends in more than 12 hours, you cannot change existing attribute data, but you can add attributes that were not previously specified. The most reliable way to do this is to pass in the entire AttributeSetArray with all the attributes you want in the listing (not just the ones you want to change, because that usually causes the others to be removed). To delete all attributes when you revise or relist, specify Item.AttributeSetArray in DeletedField and don't pass AttributeSetArray in the request. If the original listing's attributes are no longer valid and you get errors when you try to revise the listing, you can try to pass in the entire AttributeSetArray again with corrections. If that doesn't work, you can end the item and relist it with a set of valid attributes.

For AddLiveAuctionItem and ReviseLiveAuctionItem only: For AddLiveAuctionItem and ReviseLiveAuctionItem, specify a maximum of one AttributeSet for Item Specifics that are associated with SecondaryCategory (a US eBay site category), plus any number of additional AttributeSet properties for site-wide attributes that are applicable to the US eBay site.

For GetCategoryListings only: For GetCategoryListings, AttributeSetArray can return the item condition (not other Item Specifics), if specified.

For GetSearchResults only: GetSearchResults can return the item condition when the request either specifies IncludeCondition as true; or specifies a product finder search (and a detail level of ItemReturnAttributes or ReturnAll). If IncludeCondition was true, see the ItemSpecific node for a simpler view of the condition value.
Note: AttributeSetArray only returns the condition attribute's ValueID. You would need to use GetAttributesCS to figure out the meaning of this ID. It's easier to just look at the ItemSpecific node.
If SearchRequest or TicketFinder was used to perform a product finder search, the list of attributes is limited to Item Specifics that would be included in the summary search results on the Web site, if any. At this time, GetSearchResults only returns event ticket venue name, section, and row (if specified) for eBay US (site 0); and the mileage and year for eBay Motors vehicles (site 100 and international eBay Motors sites that support this feature). In other categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.)

For GetItemRecommendations only: In GetItemRecommendations, if you use the Suggested Attributes engine, the engine interprets attributes you pass in as attributes that do NOT need recommendations (i.e., attributes that the seller has already filled in as desired). The engine only returns recommendations for attributes that you do not specify, and only for attributes associated with the primary category.

For Half.com, this is only returned in GetItem. It is not applicable in AddItem and other requests.

If true, the seller requests immediate payment for the item. If false or not specified, immediate payment is not requested. (In responses, does not indicate whether the item is actually still a candidate for purchase via immediate payment.)

Only applicable to items listed on PayPal-enabled sites in categories that support immediate payment (see AutoPayEnabled in GetCategories), when seller has a Premier or Business PayPal account (see PayPalAccountType in Getuser). If true, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods).

Not supported if ThirdPartyCheckout is true.

See the eBay Web Services guide section on Immediate Payment for additional requirements and dependencies. Also see the section on working with the eBay Motors site for additional rules. Not applicable to Half.com.

Container for BestOffer properties associated with the item. Not applicable to Half.com.

Indicates, when true, that an item is available by Best Offer.

Detailed information about a bid. For GetMyeBayBuying, returned as a self-closed element if no bids meet the request criteria. Not applicable to Half.com.

This flag is set to true if a watched item belongs to a bid group. It will only be returned for the Watch container.

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.

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.

Indicates the status of the item's eligibility for the PayPal Buyer Protection program. Not applicable to Half.com.

New Container for buyer requirements. The old container, BuyerRequirements, has been deprecated. All global MyeBay Buyer Requirements are over-ridden by the contents of this container. This means that buyer requirements set in MyeBay cannot be combined with buyer requirements included in this container. When this container is present in an AddItem 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. Not applicable to Half.com.

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.

For Chinese auction listings, Buy It Now allows a user to purchase the item at a fixed price and end the auction immediately. Use this field to add Buy It Now and specify the amount a buyer would need to bid to take advantage of the Buy It Now feature.

On the main eBay site, not applicable to fixed-price items (ListingType values StoresFixedPrice or FixedPriceItem), AdFormat listings, or Half.com listings. For fixed-price and Half.com listings, see StartPrice instead. See the eBay Web Services Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing.

Once a Chinese auction has bids (and the high bid exceeds the reserve price, if any), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that the seller originally set for the listing. You can use Item.SellingStatus.BidCount to determine whether an auction with Buy It Now has bids or not. With GetSearchResults, you can use the Item.SearchDetails.BuyItNowEnabled flag to determine whether the item can still be purchased using Buy It Now. With GetItem, you can use the Item.ListingDetails.BuyItNowAvailable flag to determine whether the item can still be purchased using Buy It Now.

On some sites, the Buy It Now price for a Chinese auction may remain available for certain categories even after a bid is placed. See the "Longer Lasting Buy It Now" link below for more details and the latest list of eBay US categories that support this behavior. The eBay Spain site supports this behavior for all categories.

For a listing to be eligible for Express, the max Buy It Now Price is USD 10,000.00 for the US. (Additional price limits may be imposed by 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, as they may vary for each user.)

To remove this value when revising or relisting an item, use DeletedField.

Allows eBay to auto-fill some of a listing's Item Specifics (attribute) values based on the listing's category (or categories). Auto-filling attributes based on a category is not the same as using Pre-filled Item Information based on a catalog product (see ProductListingDetails). If true, also specify Item.CategoryMappingAllowed with a value of true. (Alternatively, you can auto-fill attributes on the client side by using mapping meta-data returned by GetAttributesCS.) See the eBay Web Services guide for more information. Ignored if the category does not support auto-filling attributes.

If you also pass in attributes in AttributeSetArray, your values will override any auto-filled values for the same attributes. Once you have overridden the value of an auto-filled attribute for a given listing, eBay will not auto-fill it on subsequent ReviseItem requests (even if you remove the overridden value).

Not applicable to Half.com.

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

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

Giving Works listings are not eligible for some eBay Express sites. (If ExpressListing is false in GetItem or VerifyAddItem and you specified Charity, check whether ExpressItemRequirements returns NoCharity as a cause.)

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. For a Store Inventory listing, you can revise an item to add a charity if the item has not been sold. You cannot revise listings to add charity for Ad Format listings.

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

Not applicable to Half.com.

The email and phone lead fee for a pay-per-lead item.

Two-letter ISO 3166 country code. In some calls, used with the Location field to indicate the city and country where the item is located. Also applicable as input to AddItem and related calls when you list items to Half.com (specify US).
For English names that correspond to each code (e.g., KY="Cayman Islands"), call GeteBayDetails or see the ISO site:http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html

In GetSearchResultsExpress, only returned when ItemDetails is set to Fine.

For a fee, enables a listing to be displayed in the default search results of another eBay site. Use this value if you want to take advantage of the International Site Visibility listing upgrade.

Container for cross-promoted items related to a specific item ID. The items are either upsell or cross-sell, according to the promotion method passed in the request. Not applicable to Half.com.

Currency associated with the item's price information. 3-letter ISO 4217 currency code that corresponds to the site specified in the item-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.

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 related eBay policy, see http://pages.ebay.com/help/policies/listing-javascript.html.)

The Description field is required for all listings, except certain listings that include Pre-filled Item Information. (See "About the Pre- filled Item Information API." in the eBay Web Services Guide.) Even if your application does not support listings items with Pre-filled Item Information, you should be aware that this also means GetItem, GetSellerList, and GetBidderList may return some items with empty Description fields.

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 eBay Web Services Guide.

For eBay Live Auctions listings, JavaScript is not allowed.

Not applicable to Half.com. (For Half.com, use AttributeArray.Attribute with attributeLabel="Notes" to specify a brief description or note to the buyer.)

If you are changing the description of an item, specifies whether the new next is an addition, a replacement, etc.

If false (or omitted): if BuyerRequirementDetails are present, those requirements are to be used; otherwise, any requirements specified in My eBay are to be used. If true: no requirements are considered from any source (and if BuyerRequirementDetails are present, they are ignored).

Specifies the maximum number of business days the seller commits to for shipping an item to domestic buyers after receiving a cleared payment. The seller sets this to an integer value (1, 2, 3, 4, 5, 10, 15, or 20) corresponding to the number of days. To add Get It Fast to listings, in addition to setting GetItFast to true, DispatchTimeMax must be set to 1 and the seller must specify at least one qualifying expedited shipping service. GetItem returns DispatchTimeMax only when shipping service options are specified for the item and the seller specified a dispatch time.

The distance used in a proximity search distance calculation. Not applicable to Half.com.

Returns a note from eBay displayed below items in the user's My eBay account. Not applicable to Half.com.

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.

An ISBN value, UPC value, EAN value, ticket keywords, or eBay catalog product ID, plus other meta-data that you specify. Only applicable to certain categories. See the eBay Web Services Guide for information on the categories that currently support usage of this field.

For AddItem and VerifyAddItem only: Causes eBay to list the item with Pre-filled Item Information based on the value you specify. If you are listing in a media category and the primary and secondary category are both catalog-enabled, the external ID must be for a product associated with the primary category. If only one category is catalog-enabled, this external ID must be for a product that is associated with the catalog-enabled category. If you are listing an event ticket, the external ID must be associated with the primary category.

Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem (or VerifyAddItem) request. Do not specify both. If you use Item.ExternalProductID instead of Item.ProductListingDetails, eBay sets IncludeStockPhotoURL and IncludePrefilledItemInformation to true automatically.

The stock photo URL satisfies the eBay Express picture requirement. See the eBay Web Services Guide links below for more details.

Optional for eBay.com listings. Applicable to Half.com listings.

For ReviseItem and RelistItem only: ExternalProductID is not applicable when revising and relisting items (use Item.ProductListingDetails instead).

For GetItemRecommendations only: In GetItemRecommendations, only applicable when the value of ListingFlow is AddItem. Not applicable when the recommendation engine is ProductPricing.

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.

Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day. Not applicable to Half.com. GetItFast is not supported for UK Store Inventory format items.

If true, a generic gift icon displays next the listing's title in search and browse pages. GiftIcon must be set to be able to use GiftServices options. Note that one/zero is returned instead of true/false. Not applicable to Half.com.

Optional gift services that the seller is offering if the buyer chooses to purchase the item as a gift. Only returned if offered by the seller. Not applicable to Half.com.

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.

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.

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. This field is ignored when Item.ListingType=Express.

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

In GetSearchResultsExpress, always returned when ItemArray.Item is returned.

For GetCart/SetCart input, this is only required if the parent container is submitted.

Specifies the details of policy violations if the item was administratively canceled.

A list of attribute or Item Specific name and value pairs that the seller specified for the item.

In the AddItem family of calls, use this for specifying custom Item Specifics. (If you are including an Item Condition or Return Policy, use AttributeSetArray for these details as usual instead. You can use AttributeSetArray and ItemSpecifics in the same request in this case.)

To determine which categories support custom Item Specifics, use GetCategoryFeatures.

Note: If you are trying to list with ID-based attributes from GetAttributesCS or GetProductSellingPages, use AttributeSetArray instead.

To retrieve recommended Item Specifics, use GetCategorySpecifics or GetItemRecommendations.

In GetItemRecommendations, pass in the PrimaryCategory and (optionally) Title to retrieve recommended names and values.

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.

With GetProducts, only the item condition is returned at the item level. Additional attributes that were pre-filled from the catalog are returned in Product.ItemSpecifics.

Applicable to US eBay Motors vehicle listings only. If false, the vehicle will not be considered for a limited warranty by eBay. If your application lists Motors vehicles, you must 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 is passed in, it means the application has presented the seller with checkboxes to indicate this information. If true, the seller has verified that the vehicle has not been modified and is not a special type. If false, the seller has verified that vehicle has been modified or it is a special type. Passing a value of true does not guarantee that eBay will offer a limited warranty. It only makes the listing eligible for consideration. See the eBay Web Services Guide for more information about Motors vehicle listings. Not applicable to Half.com.

ProStores listing level preferences regarding the store to which checkout should be redirected for the listing if ThirdPartyCheckout is true. If not set (and ThirdPartyCheckout is true), third party checkout is redirected to the listing application.

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.

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.

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.

Also required for Half.com (but only specify GTC).

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.

Describes listing upgrades that sellers can select for a fee, such as the BoldTitle upgrade. Also includes feature packs for saving on listing upgrades. See Listing Upgrades in the eBay Web site online help.

You cannot remove listing upgrades when you revise a listing. When you relist an item, use DeletedField to remove a listing upgrades.

For AddLiveAuctionItem and ReviseLiveAuctionItem, you can specify a maximum of 10 featured lot items per live auction catalog. Not applicable to Half.com. This field is ignored when Item.ListingType=Express.

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.

The format of the listing the seller wants to use, such as Chinese auction or fixed price.

Optional for eBay.com listings (defaults to Chinese) in AddItem and VerifyAddItem. On the US, Germany, and UK sites, eligible items listed in the fixed price, Store Inventory, or (for the US) in the Chinese auction format with Buy It Now are also included on eBay Express. Express Germany and UK also support an Express format for listing only on Express.

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

Describes the live auction-specific details of a lot item. Applicable to eBay Live Auctions only.

Indicates, when true, that an item is available locally.

Indicates the geographical location of the item (along with Country). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours.

If you do not specify Location, you must specify Item.PostalCode. If you specify a postal code, but do not specify a location, then the location is given a default value derived from the postal code.

For the Classified Ad format for eBay Motors vehicles, the value provided in the Location is used as item location only if the SellerContactDetails.Street and the SellerContactDetails.Street2 are empty. Else, the SellerContactDetails.Street and the SellerContactDetails.Street2 will be used for item location.

Also applicable as input to AddItem and related calls when you list items to Half.com.

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.

Use this as a shortcut for specifying the Condition attribute by name instead of by ID. Only valid when using AddItem for items in Media categories (Books, DVD and Movies, Music, and Video Game categories) on the eBay US site (site ID 0). You can pass either AttributeSetArray or LookupAttributeArray, but you cannot pass both in the same request. Typically used in combination with ExternalProductID. Not applicable to Half.com.

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

Indicates whether the seller allows the bidder to request mechanical inspection services from RAC. For Car category listings on the UK site.

Listing upgrade that features the item in eBay search results on the mobile.de partner site. Applicable to eBay Germany. If true in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site. See the eBay Web Services Guide for applicable categories, revise and relist rules, and additional information on featuring vehicles on the Mobile.de Site. Not applicable to Half.com.

If true in listing requests and responses, the item is listed with Now and New. Only applicable to Buy It Now, fixed-price, and Store Inventory listings on certain eBay sites. See the eBay Web Services guide for details. In requests that list items, only valid if the seller also specifies the item condition (as new), predefined return policy attributes, a buy it now or fixed price, and shipping costs. To remove Now and New from a listing, set the value to false. If the listing has bids (or items have been sold) or the listing ends within 12 hours, you cannot add or remove NowAndNew when you revise the listing. Not applicable to Half.com.

Contains data associated with eBay Motors payments (Durations for deposit and full payments). Returned for Motors listings. Not applicable to Half.com.

Identifies the payment method (such as credit card or PayPal) the seller will accept for the buyer to pay for the purchase of the item.

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>AmEx</PaymentMethods>
<PaymentMethods>PersonalCheck</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 eBay Web Services guide.

Note: Required or allowed payment methods vary by site and category. Refer to Payment Method Differences (PaymentMethod) in the eBay Trading API Guide for information to help you determine which payment methods you are required or allowed to specify.

For a listing to be eligible for Express US, PayPal is a required payment method. For Express Germany, Express format listings (Item.ListingType=Express) must include PayPal, but fixed-price and Store Inventory listings do not require PayPal as long as a default PayPal account is specified in the seller's Express preferences. See eBay Express information in the eBay Web Services Guide.

Payment methods are not applicable to eBay Real Estate ad format listings, Classified Ad format listings, or Half.com.

Note: At the end of April 2008, UK and Germany eBay Express will be shutdown. No users will be eligible to list on these sites. All users previously registered on UK and Germany Express will have their registered status revoked. Any Express only items listed on these sites will be ended and credited the full insertion fee to their sellers. Please refer to the respective Express sites for more information.

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.

For GetProducts only: Only PayPal is returned in product search results.

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 a listing to be eligible for Express US, the seller needs to use an email address that is in good standing and that is associated with a PayPal Premier or PayPal business account that is set to ship to unconfirmed addresses. For Express Germany, PayPalEmailAddress must be specified for Express format listings, but it is optional for other formats (as long as an eligible default PayPal account is specified in the seller's Express preferences). If the specified PayPal account becomes ineligible for eBay Express payments (because the seller blocked unconfirmed addresses or some other change occurred), the items associated with that account may become ineligible for Express and may no longer appear on Express.

Note: At the end of April 2008, UK and Germany eBay Express will be shutdown. No users will be eligible to list on these sites. All users previously registered on UK and Germany Express will have their registered status revoked. Any Express only items listed on these sites will be ended and credited the full insertion fee to their sellers. Please refer to the respective Express sites for more information.

See eBay Express information in the eBay Web Services Guide for more information.

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. Also not applicable to Half.com.

Contains the data for a picture associated with an item.

For a listing to be eligible for eBay Express, it must include a picture, gallery, or stock photo URL. Some categories are exempt from this requirement. See the eBay Web Services Guide links below for details.

Not applicable to Half.com.

Note: PictureDetails replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with request version 439 or greater. As SiteHostedPicture and VendorHostedPicture are also no longer recommended on input, applications should use PictureDetails in the input as well. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails takes precedence.

Postal code of the place where the item is located. This value is used for proximity searches. To remove this value when revising or relisting an item, use DeletedField. If you do not specify PostalCode, you must specify Item.Location. If you specify PostalCode, but do not specify Item.Location, then Item.Location is given a default value derived from the postal code. Not applicable to Half.com.

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.

Most eBay.com categories are also eligible for eBay Express. Categories not covered by PayPal Buyer Protection are excluded. Also, certain categories that do not support item condition may be excluded (use GetCategoryFeatures to determine eligible categories). See "eBay Express" in the eBay Web Services Guide.

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.

Not applicable to Half.com.

For ReviseItem only: When revising a listing, you can change the primary category only if an item has no bids (or no items have sold) and the listing does not end within 12 hours.

If you change the listing category, any Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the new category. See Item.AttributeSetArray. For the eBay US site, we suggest that you avoid including a category ID when you use ExternalProductID. 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.

For AddLiveAuctionItem only: For eBay Live Auctions (e.g., in AddLiveAuctionItem), this is the eBay Live Auctions site category in which to list the item. This can be different from the category that is associated with the seller's catalog. See Specifying eBay Live Auctions Categories in the eBay Web Services guide.

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 eBay Web Services guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attributes engine.

For GetProducts: Use GetCategories if you need to determine the name of the category.

If true, designates the listing as private. When you create a private listing, a buyer's User ID will not appear in the listing or in the listing's bid history. Sellers may want to use this option when they believe that potential bidders for a listing would not want their User IDs disclosed to others. Not applicable to Half.com.

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

Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)

Specifies stock product information to include in a listing. Only applicable when listing items with Pre-filled Item Information. If the item's primary and secondary category are both catalog-enabled, the product listing details must be applicable to the primary category. If only one category is catalog- enabled, the product listing details must be applicable to the catalog-enabled category. Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem request, but not both. See the eBay Web Services Guide for information on listing with Pre-filled Item Information.

For ReviseItem and RelistItem only: If a listing includes Pre-filled Item Information and you change a category, the rules for continuing to include Pre-filled Item Information 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 GetItemRecommendations only: For GetItemRecommendations, see the eBay Web Services guide for validation rule differences when using the Product Pricing engine.

Not applicable to Half.com.

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.

For AddItem and related calls, this is the number of items in the listing. For new listings being defined, this is the initial number of items the seller offers for sale. Even during a Dutch auction, where one of several items can be purchased during the auction, this number does not change. Sellers need to meet certain feedback requirements to specify a quantity greater than 1.

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. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller.

For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1.

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.

Specifies how many of a certain item are available. Not applicable to Half.com.

For GetSearchResultsExpress, only returned when ItemDetails is set to Fine.

Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com.

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.

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.

The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support reserve prices. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the eBay Web Services 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 eBay Web Services guide for validation rules when revising US Motors listings.

For AddLiveAuctionItem and ReviseLiveAuctionItem, the seller needs to make sure they specify the amount in the currency selected for the live auction event. When you revise a Live Auction item, you can lower an existing reserve price, but you cannot add a reserve price or remove an existing reserve price if the item has absentee bids or ends in less than 12 hours.

Not applicable to Half.com. This field is ignored when Item.ListingType=Express.

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. Output only. Not applicable to Half.com.

Allows a user to schedule a listing to start at the specified time in the future. Specify the time (in GMT) that the item's listing is scheduled to be active on eBay. In GetItem and related calls, the scheduled time is returned in StartTime. For ReviseItem, you can modify this value if the current schedule time is in the future. Not applicable to Half.com. Also see the following article in the Knowledge Base: Why scheduled time is sometimes getting reset.

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.

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.

Most eBay.com categories are also eligible for eBay Express. Categories not covered by PayPal Buyer Protection are excluded. Also, certain categories that do not support item condition may be excluded.

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.

To remove this value when relisting an item, use DeletedField.

For ReviseItem only: When revising a listing, you can add, remove, 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.

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 AddLiveAuctionItem only: For eBay Live Auctions (e.g., AddLiveAuctionItem), this is the eBay US site category in which to list the item. (This can be any eBay US category except Motors or Real Estate categories.) Note that eBay Live Auctions does not charge a fee to specify an eBay category (i.e., no List in Two Category fees). See Specifying eBay Live Auctions Categories in the eBay Web Services guide. In AddLiveAuctionItem, you need to specify SecondaryCategory if you are including Item Specifics (AttributeSetArray).

For ReviseLiveAuctionItem only: For eBay Live Auctions, you can add SecondaryCategory when you revise the lot item, but you cannot change or remove an existing secondary category if the item has absentee bids or it ends in less than 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 eBay Web Services guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attributes engine.

Container for information about this listing's seller. Not applicable to Half.com.

In GetSearchResultsExpress, only returned when ItemDetails is set to Fine.

Returned by GetCart/SetCart only if there are items in the cart.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.

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

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.

The seller is on vacation (as determined by the seller's store preferences) in two cases: i.) the item is a Store Inventory item and the seller has chosen to hide Store Inventory items while on vacation, and ii.) the seller has chosen to add a message to listed items while on vacation. Not applicable to Half.com.

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.

For GetSearchResultsExpress, this is always returned when ItemArray.Item is returned.

Returned by GetCart/SetCart only if there are items in the cart.

The shipping-related details for an item or transaction, 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 multi-quantity Store Inventory Format listings and for multi-quantity 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.

For a listing to be eligible for eBay Express, shipping details are required (to support the eBay Express shopping cart). For flat shipping, this means the shipping service and cost are required. For calculated shipping, it means all of the usual parameters (weight, originating postal code, etc.) are required. See the the eBay Web Services Guide links below for more information. In GetSearchResultsExpress, always returned when ItemArray.Item is returned.

This container is returned by GetCart or SetCart only when a valid postal code is provided for the country (see SetCart.ShippingAddress) and there is at least one item in the shopping cart for which calculated shipping is offered.

Shipping details are not applicable to Real Estate listings and Half.com.

Indicates whether details about shipping costs and arrangements are specified in the item description. Not applicable to Half.com.

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 a DetailName of ShippingLocationDetails to determine which international locations are valid for the site. 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. Not applicable to Half.com.

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 (e.g., GetCategoryListings), and other information. In some cases (such as with listings on eBay Express), 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, 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. For eBay Live Auctions, pass a value of US.