eBay Trading API933

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 ItemType:

Fields

AttributeSetArray ( AttributeSetArrayType )
Distance ( DistanceType )
LookupAttributeArray ( LookupAttributeArrayType )
SearchDetails ( SearchDetailsType )
UnitInfo ( UnitInfoType )
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]
Different Buyer protection schemes and the various status associated with each one of them.
See the Field Index to learn which calls use ApplyBuyerProtection.

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

AttributeSetArray ( AttributeSetArrayType ) [0..1]
Not used by any call.

This type has been deprecated.
See the Field Index to learn which calls use AttributeSetArray.

AutoPay ( boolean ) [0..1]
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).


To create an Immediate Payment listing, AutoPay must be true, PayPalEmailAddress must be a valid PayPal email address for the seller, and PaymentMethods must be PayPal. AutoPay can be enabled for ThirdPartyCheckout apps that have been approved by eBay. For a non-Immediate Payment listing, AutoPay flag is not required.

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 is returned as true if the seller has enabled the item with the 'Click and Collect' feature. With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK and Australia sites, and then pick up their order from the nearest 'eBay Collection Point', including over 750 Argos stores in the UK. The Click and Collect feature is only available on the eBay UK and Australia sites. For more information about Click and Collect, see the Click and Collect home page on the eBay UK site or the Click and Collect home page on the eBay Australia site.

Not all categories on the UK and Australia sites support Click and Collect listings. To verify if a specific category on these eBay sites support Click and Collect listings, use the GetCategoryFeatures call, passing in one or more CategoryID values and a PickupDropOffEnabled value in the FeatureID field. Look for a true value in the PickupDropOffEnabled field of the corresponding Category node (match up the CategoryID values if more than one Category IDs were passed in the request).
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.

This boolean field is returned as 'true' if the seller has enabled the 'Best Offer' feature on a fixed-price listing. The Best Offer feature is not applicable to auction listings.
See the Field Index to learn which calls use BestOfferEnabled.

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

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

This field is no longer used.
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 ( BuyerProtectionCodeType ) [0..1]
Flag to indicate an item's eligibility for the PayPal Buyer Protection program. This field is only returned if 'true'. If this field is not returned, the item is not eligible for PayPal Buyer Protection. For more information on items that are eligible for PayPal Buyer Protection, see the PayPal Buyer Protection help page.

Not applicable to Half.com.
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]
Note: For the US site, users who are registering as eBay sellers for the first time are subject to seller limits which limit the quantity of items and/or the total listing value of the items. This applies to new sellers, not currently to existing sellers. (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 auctions, the value limits apply to the start price, not the final sale amount. For more information, see the link to Seller Limits below.

For 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 Revising US eBay Motors Listings in the eBay Features Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing.

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

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

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

ClassifiedAdPayPerLeadFee ( AmountType (double) ) [0..1]
The email and phone lead fee for a pay-per-lead item.
See the Field Index to learn which calls use ClassifiedAdPayPerLeadFee.

ConditionDefinition ( string ) [0..1]
This string value provides more details about the item's condition.
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. 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.

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.

Some categories may support ConditionID but also define conditions in GetAttributesCS or GetCategorySpecifics. Even if a category still seems to support passing item condition in AttributeSetArray, LookupAttributeArray, or ItemSpecifics fields, you should use ConditionID instead.

US eBay Motors vehicle categories will support ConditionID in a future release. Use AttributeSetArray to specify a vehicle's item condition instead. Keep an eye on the eBay Developers Program newsletter for updates.

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: Only returned when the seller specified ConditionID in their listing. GetItem 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 ( CountryCodeType ) [0..1]
Defines the 2-letter country code set.

Use the GeteBayDetails call to see the list of currently supported codes, and the English names associated with each code (e.g., KY="Cayman Islands"): GeteBayDetails

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

Description ( string ) [0..1]
The seller's description of the item. In listing requests, you can submit your description using CDATA if you want to use HTML or XML-reserved characters in the description. An error is returned if this contains malicious JavaScript content. (For related eBay policy, see http://pages.ebay.com/help/policies/listing-javascript.html.)

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 Working with Pictures in an Item Listing in the eBay Features Guide.

Required for all listings, except listings that include eBay catalog product details. Optional when you list with product details and Item.ProductListingDetails.IncludePrefilledItemInformation is true.

For GetItem: Item.Description can be empty when IncludePrefilledItemInformation is true and the seller did not write their own description. Item.Description doesn't return pre-filled descriptions from catalogs. The eBay site shows the catalog product description (if any) in the product details section of a listing. To retrieve a URL for the catalog product details page, see DetailsURL in GetProductSearchResults, GetProductFamilyMembers, or GetProductSellingPages. Or see DetailsURL in FindProducts in the Shopping API (which may be easier to use if your application doesn't support eBay Attributes).

Not applicable to Half.com. (For Half.com, use AttributeArray.Attribute with attributeLabel="Notes" to specify a brief description or note to the buyer.)
See the Field Index to learn which calls use Description.

DescriptionReviseMode ( DescriptionReviseModeCodeType ) [0..1]
If you are changing the description of an item, specifies whether the new next is an addition, a replacement, and so on.
See the Field Index to learn which calls use DescriptionReviseMode.

DigitalGoodInfo ( DigitalGoodInfoType ) [0..1]
Note: This field will be enabled with version 935. For those using versions older than 935, this field will not be available for use in the listing calls, nor returned in GetItem.
This container is used in add/relist/revise/verify listing calls to designate the listing as a digital gift card listing. It is also returned in GetItem to indicate that the listing contains a digital gift card.
See the Field Index to learn which calls use DigitalGoodInfo.

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, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain 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 to a positive integer value corresponding to the number of days. For a list of allowed values on each eBay site, use DispatchTimeMaxDetails in GeteBayDetails. (Typical values are 1, 2, 3, 4, 5, 10, 15, or 20, but this can vary by site and these may change over time.)

Valid for flat and calculated shipping. Does not apply when there is no shipping, when it is local pickup only or it is freight shipping. For example, when ShippingService=Pickup or ShipToLocations=None, then DispatchTimeMax is not required (or it can be 0).

To add Get It Fast to listings (for domestic shipping), in addition to setting GetItFast to true, DispatchTimeMax must be set to 1 and the seller must specify at least one qualifying expedited shipping service.

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]
Not used by any call.

Note: eBay Now has been officially retired in all US locations, so this field no longer is applicable for US listings. However, a feature similar to eBay Now, called 'eBay Scheduled Delivery', is available in some parts of London, so this field is still applicable on the eBay UK site.
This boolean field is returned as true if the seller has enabled the item with the eBay Scheduled Delivery feature. With eBay Scheduled Delivery, buyers in the London area are able to purchase an item, and then select a short time window (the same day or the following day) in which the item will be delivered. For some eBay Scheduled Delivery listings, buyers may be able to select an 'As soon as possible' delivery option where a courier will deliver their item within two hours.
See the Field Index to learn which calls use eBayNowAvailable.

eBayNowEligible ( boolean ) [0..1]
Note: eBay Now has been officially retired in all US locations, so this field no longer is applicable for US listings. However, a feature similar to eBay Now, called 'eBay Scheduled Delivery', is available in some parts of London, so this field is still applicable on the eBay UK site.
This boolean field is returned as true if the listing category supports eBay Scheduled Delivery. A true value does not necessarily mean that the seller has enabled the item with the eBay Scheduled Delivery feature. A listing is enabled with the eBay Scheduled Delivery feature if the eBayNowAvailable field is returned as true.

With eBay Scheduled Delivery, buyers in the London area are able to purchase an item, and then select a short time window (the same day or the following day) in which the item will be delivered. For some eBay Scheduled Delivery listings, buyers may be able to select an 'As soon as possible' delivery option where a courier will deliver their item within two hours.
See the Field Index to learn which calls use eBayNowEligible.

eBayPlus ( boolean ) [0..1]
If true, this item is being offered under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.

Note: Currently, eBay Plus is available only to buyers in Germany (DE).
See the Field Index to learn which calls use eBayPlus.

eBayPlusEligible ( boolean ) [0..1]
If true, this item is is eligible to be listed under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top Rated eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.

Note: Currently, eBay Plus is available only to buyers in Germany (DE).
See the Field Index to learn which calls use eBayPlusEligible.

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

This boolean field is returned as true if the listing category supports 'Click and Collect' listings. A true value does not necessarily mean that the seller has enabled the item with the Click and Collect feature. A listing is enabled with the Click and Collect feature if the AvailableForPickupDropOff field is returned as true.

With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK and Australia sites, and then pick up their order from the nearest 'eBay Collection Point', including over 750 Argos stores in the UK. The Click and Collect feature is only available on the eBay UK and Australia sites. For more information about Click and Collect, see the Click and Collect home page on the eBay UK site or the Click and Collect home page on the eBay Australia site.
See the Field Index to learn which calls use EligibleForPickupDropOff.

eMailDeliveryAvailable ( boolean ) [0..1]
Note: This field will be enabled with version 935. For those using versions older than 935, this field will not be returned.
The boolean value that is returned in this field will indicate whether or not a digital gift card can be delivered by email to the buyer or recipient of the gift card. This field is only applicable to digital gift card listings.
See the Field Index to learn which calls use eMailDeliveryAvailable.

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 deprecated in a future project. New applications should use ProductListingDetails instead of ExternalProductID for AddItem and related calls.

Contains an ISBN value, UPC value, EAN value, ticket keywords, or eBay catalog product ID. Causes eBay to list the item with Pre-filled Item Information based on the value you specify. Only applicable to certain categories.
For AddItem and VerifyAddItem only: On the US site, if you are listing in a media category, eBay determines the primary category ID based on the product ID you specify (and CategoryID is usually ignored). To avoid confusion (e.g., at revise/relist time), it's a good idea to avoid specifying the primary category in combination with ExternalProductID.

Note: There may be cases when the category ID can't be determined and you get an error. If this does occur, then specify the category ID.
If you are listing in two categories and both are catalog-enabled, the external ID should be for a product associated with the primary category. If only one category is catalog-enabled, the external ID should be for a product that is associated with the catalog-enabled category.

If you are listing an event ticket, the primary category is required, and 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.

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.
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 enabled to use 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 supported for UK Store Inventory format items.
Not applicable to Half.com.
See the Field Index to learn which calls use GetItFast.

GiftIcon ( int ) [0..1]
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.

When the Top-Rated Seller program became operational, some enhanced listing features were removed or restricted to certain sellers on some sites. Use GeteBayDetails ListingFeatureDetails for more information.

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

GiftServices ( GiftServicesCodeType ) [0..*]
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.

When the Top-Rated Seller program became operational, some enhanced listing features were removed or restricted to certain sellers on some sites. Use GeteBayDetails ListingFeatureDetails for more information.

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]
This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
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 ( HitCounterCodeType ) [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 boolean field is returned as true if the actual quantity of a multiple-quantity, fixed-price listing (indicated in the Item.Quantity field) can not be accurately determined by eBay.
See the Field Index to learn which calls use IgnoreQuantity.

IncludeRecommendations ( boolean ) [0..1]
This boolean field should be included and set to true if the seller wishes to see listing recommendations in the call response via the ListingRecommendations container. Listing recommendations provide one or more messages to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.
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 ( InventoryTrackingMethodCodeType ) [0..1]
Indicates whether you prefer to track your eBay listings by eBay Item ID or by your own SKU.

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]
This boolean field is returned as true if the item is eligible is to be shipped internationally via eBay's Global Shipping Program. With the Global Shipping Program, the buyer pays a single shipping fee for the order, which includes the domestic shipping leg, the international shipping leg, and handling charges, and import charges. eBay uses a shipping partner that allows the seller to ship the package to a domestic location and then the shipping partner takes care of the rest, including the international shipping leg.
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.

Parts Compatibility is supported in limited Parts & Accessories categories for the eBay Motors (US) site (site ID 100) only.
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 describe 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: Starting with release 687, invalid item compatibility combinations will not cause the request to fail as long as ItemCompatibilityList contains at least one valid item compatibility. Only valid compatibilities will be added to the listing. Any invalid compatibility combinations will be reported in the long error message in the response errors with a severity of Warning.


For ReviseFixedPriceItem and ReviseItem: When you revise a listing, if the listing has bids and/or ends within 12 hours, item compatibilities cannot be deleted. You may add item compatibilities at any time.

For GetItem: ItemCompatibilityList is only returned if the seller included item compatibility in the listing and IncludeItemCompatibilityList is set to true in the GetItem request.

Parts Compatibility is supported in limited Parts & Accessories categories for the eBay Motors (US) site (site ID 100) only.

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 line item calls (e.g., GetItemTransactions), use a combination of OrderLineItemID to uniquely identify a 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.

In GetSearchResults, the same ItemID may be returned for multiple results if the results are variations from the same multi-variation listing.

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

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.

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

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 ( ListingEnhancementsCodeType ) [0..*]
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 site help.

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

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

ListingSubtype2 ( ListingSubtypeCodeType ) [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 ( ListingTypeCodeType ) [0..1]
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 auction) 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).

The FixedPriceItem listing format has replaced the StoresFixedPrice listing format, and the StoresFixedPrice format has been deprecated. Currently, AddItem and AddFixedPriceItem accept either FixedPriceItem or StoresFixedPrice as listing formats, but the item will be displayed as FixedPriceItem on the site and in search results. GetItem and other 'Get' calls will return the format you originally used in the request. Therefore, the preferred format is FixedPriceItem.

As part of the merge of the StoresFixedPrice and FixedPriceItem formats, the start price of all new FixedPriceItems must be 99 cents or greater.
See the Field Index to learn which calls use ListingType.

LiveAuction ( boolean ) [0..1]
This field must be included and set to true if the listing will be a part of a Live Auction. This boolean field is returned as true in GetItem if the listing is part of a Live Auction. See the eBay Live Auctions home page for more information about Live Auctions on eBay.com.
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). 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.
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]
Not used by any call.

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-style 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]
Listing upgrade that features the item in eBay search results on the mobile.de partner site. Applicable to eBay Germany.

If true in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site.

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

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 ( SiteCodeType ) [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]
Contains data associated with eBay Motors payments (Durations for deposit and full payments). Returned for Motors listings.

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

PaymentMethods ( BuyerPaymentMethodCodeType ) [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 must be specified.

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 methods for a site.

Do not use GeteBayDetails to determine the payment methods for a site.

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 API Schema in the eBay Features Guide.

Note: Required or allowed payment methods vary by site and category. Refer to Determining the Payment Methods Allowed for a Category in the eBay Features Guide to help you determine which payment methods you are required or allowed to specify.
Payment methods are not applicable to eBay Real Estate ad format listings, Classified Ad format listings, or Half.com.

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.
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/relist/revise/verify listing calls by the seller to enable a listing with the 'In-Store Pickup' or 'Click and Collect' features. The 'In-Store Pickup' feature is only available on the eBay US site, and the 'Click and Collect' feature is only available on the eBay UK and Australia sites. Both of these features are discussed in more detail in this container's child fields. This container is also returned in the GetItem call.
See the Field Index to learn which calls use PickupInStoreDetails.

PictureDetails ( PictureDetailsType ) [0..1]
Contains the data for a picture associated with an item.

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

PostCheckoutExperienceEnabled ( boolean ) [0..1]
This boolean field indicates whether or not the listing is enabled with the Post-Checkout Experience.
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 Maintaining Category Data for information on working with categories). Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill.

There are a number of categories on some eBay sites that always add the Gallery feature (for free) when you include a picture in the listing and you don't specify the Gallery feature yourself. See GalleryType for information about fees that could be charged if you change the category in these cases.

Coming soon: If you list with a catalog product, eBay may drop the primary category you specify and use the category that is associated with the product instead, if different.

Not applicable to Half.com.

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

If you change the listing category, any Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the new category. See Item.AttributeSetArray. For the eBay US site, we suggest that you avoid including a category ID when you list with an external product ID, such as ISBN. See the KB article listed below for details.

You cannot change the meta-categories for vehicles (i.e., you cannot change a truck to a motorcycle), but you can change the leaf category (e.g., change one motorcycle subcategory to another motorcycle subcategory). 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 GetProducts: Use GetCategories if you need to determine the name of the category.
See the Field Index to learn which calls use PrimaryCategory.

PrivateListing ( boolean ) [0..1]
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.
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.

As ProductID and ProductReferenceID are defined by eBay, they provide the most reliable means to identify a product. If you use ISBN, UPC, EAN, BrandMPN, and/or TicketListingDetails, 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 the catalog search calls (such as GetProductSearchResults or GetProducts) to find a ProductID or ProductReferenceID.

When you specify ProductListingDetails, you must specify at least one product ID for the listing (ProductID, ProductReferenceID, ISBN, UPC, EAN, BrandMPN, and/or TicketListingDetails). If you specify more than one of these values (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 ID 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 ID: If you list in two categories and the primary and secondary categories are both catalog-enabled, this product should correspond to the primary category (not the secondary category). If only one category is catalog-enabled, the product listing details should correspond to the catalog-enabled category. (Use GetCategory2CS to determine which categories are catalog-enabled.)

Note: As a general rule, the primary category is required. However, if you have trouble finding a catalog-enabled category, you may be able to omit the primary category (except for event tickets). If you do, eBay will attempt to determine an appropriate category based on the product ID (if we find a matching product). When you specify a category that corresponds to the product (according to GetCategory2CS), your category is used. Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem request, but not both. (ExternalProductID will be deprecated in a future release.)

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.


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]
Note: For the US site, users who are registering as eBay sellers for the first time are subject to seller limits which limit the quantity of items and/or the total listing value of the items. This applies to new sellers, not currently to existing sellers. (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 auctions, the value limits apply to the start price, not the final sale amount. For more information, see the link to Seller Limits below.

The meaning of this value depends on the context.

For AddItem family of calls: The Quantity value for auction-style listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations.

For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction-style listing should always be 1.

For RelistItem and RelistFixedPriceItem: Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was 10, and 3 items have been sold, eBay sets the relisted item's Quantity to 10 by default, and not 7. So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests.

When eBay auto-renews a GTC listing (ListingDuration=GTC) on your behalf, eBay relists with correct quantity available.

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]
This integer value indicates the quantity of an item that is still available for purchase in a multiple-quantity, fixed-price listing. This field is not applicable to auction listings.

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

QuantityAvailableHint ( QuantityAvailableHintCodeType ) [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 ( ReasonHideFromSearchCodeType ) [0..1]
This field will only be returned if the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.
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]
This boolean field is returned as 'true' if the item in this listing was relisted. When an item is relisted, a brand new Item ID value is automatically created by eBay. This field is only returned for an original listing whose item has been relisted, so a 'false' value should never get returned.

Note that the new listing will not show this field (whether it is 'true' or 'false').
See the Field Index to learn which calls use Relisted.

RelistLink ( boolean ) [0..1]
Applicable only to relisting 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]
This value is the identifier of the original listing that contained the item before the item was relisted.
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 reserve prices. See GetCategories and 'Determining Whether a Category Supports Reserve Prices'. 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 Fees Overview below for information about fee credits that may be available when the reserve price is removed for a Motors listing.

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

ReturnPolicy ( ReturnPolicyType ) [0..1]
Describes the seller's return policy. Most categories on most eBay sites require the seller to clearly specify whether or not returns are accepted (see ReturnsAcceptedOption).

For the AddItem family of calls: Required for most categories on most sites. Use ReturnPolicyEnabled in GetCategoryFeatures to determine which categories require this field. Also use ReturnPolicyDetails in GeteBayDetails to determine which ReturnPolicy fields can be used on each site.

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.

On the eBay UK, Ireland, Germany, Austria, Switzerland, and Italy sites you can list Store Inventory listings in two categories. On the eBay US and other sites, you cannot list Store Inventory listings in two categories.

You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. The Final Value Fee is based on the primary category in which the item is listed. Furthermore, you can list the same item in an eBay Motors Parts & Accessories category and in an eligible eBay category, as long as the primary category is associated with the site on which you are listing. That is, the two categories can be a mix of Motors Parts & Accessories and eBay site categories. (Real Estate, Mature Audience (adult), and Business & Industrial categories are not eligible for listing in two categories in this manner.) For example, if you list on Motors, the primary category could be 6750 (eBay Motors > Parts & Accessories > Apparel & Merchandise > Motorcycle > Jackets & Leathers), and the secondary category could be 57988 (eBay > Clothing, Shoes > Accessories > Men's Clothing > Outerwear). If you list on the main eBay site, the primary category could be 57988 and the secondary category could be 6750.

If eBay has designated a category as a value category (see 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, 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 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 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).
See the Field Index to learn which calls use SellerProvidedTitle.

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

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.

For Revise and Relist calls: To delete all shipping service cost overrides when you revise or relist, specify Item.ShippingServiceCostOverrideList in DeletedField, and don't pass ShippingServiceCostOverrideList in the request.
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 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.

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 ( SiteCodeType ) [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 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 site, the visibility of the item in some types of searches (e.g., GetCategoryListings), 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. A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs.

If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU in those calls. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

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 site 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 ( SkypeContactOptionCodeType ) [0..*]
Specifies the Skype contact options supported. 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 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, 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]
Note: For the US site, users who are registering as eBay sellers for the first time are subject to seller limits which limit the quantity of items and/or the total listing value of the items. This applies to new sellers, not currently to existing sellers. (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 auctions, the value limits apply to the start price, not the final sale amount. For more information, see the link to Seller Limits below.

The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

For auction-type listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For input on fixed-price listings (FixedPriceItem) and Store Inventory (StoresFixedPrice) listings: This is the constant price at which a buyer may purchase the item.

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 formats, Basic Fixed Price, and Store Inventory format items 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]
Determines whether or not checkout is to be handled by an authorized Third-Party Checkout application. See "Third-Party Checkout" in the main documentation.

The counterpart in the GetItem family of calls is Item.ShippingDetails.ThirdPartyCheckout.

To create an Immediate Payment listing, AutoPay must be true, PayPalEmailAddress must be a valid PayPal email address for the seller, and PaymentMethods must be PayPal. AutoPay can be enabled for ThirdPartyCheckout apps that have been approved by eBay.

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

ThirdPartyCheckoutIntegration ( boolean ) [0..1]
Only authorized Third-Party Checkout providers can use this flag.

If you are a seller, subscribe to Checkout notifications through a supporting application. Set this flag to true to enable Checkout notifications for a particular listing.

IMPORTANT: If you are not authorized to support Third-Party Checkout and your application is not the original listing application, never specify ThirdPartyCheckout or ThirdPartyCheckoutIntegration in your request (even if you revise a listing that already includes these flags). Otherwise you may get unexpected results.

Returned only if true for a listing.
Not applicable to Half.com.
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 eBay Features 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. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails.

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

For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead.

You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours.

In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations.
See the Field Index to learn which calls use Title.

TopRatedListing ( boolean ) [0..1]
This boolean field is returned as true if the listing was created by a Top-Rated Seller and the listing has all of the requirements that qualifies it as a Top-Rated Plus listing. The Top-Rated Seller program is only available on the US, UK, and Germany sites. See the Top-Rated Seller requirements help topic for more information on qualifying as a Top-Rated Seller and the Top-Rated Plus listing requirements help topic for more information on what a listing must offer to qualify as a Top-Rated Plus listing and get the Top-Rated Plus badge. Information on the overall program can be found on the Top-Rated Seller home page in the Seller Center.
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]
Not used by any call.

This container provides 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 UnitType and UnitQuantity values and the item's listed price to calculate and display the per-unit price on eBay EU sites.
See the Field Index to learn which calls use UnitInfo.

UpdateReturnPolicy ( boolean ) [0..1]
Specifies whether the Return Policy Details have been updated for the item specified in the request.
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.
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). You also can't add or change variation specifics (because they are unique identifiers). 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]
This field displays the Vehicle Identification Number, which is a unique serial number for a motor vehicle.

This field is 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 in 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.
See the Field Index to learn which calls use VIN.

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

This field contains the 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.
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 in the UK.

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

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

This field contains a 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.

This field is applicable to listings in UK eBay Motors Cars and Trucks, Motorcycle, and some Powersport categories.
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.