eBay Trading APIVersion 1349
 

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.

Types that use ItemType:

Calls that use ItemType:

Fields

CrossPromotion ( CrossPromotionsType )
Distance ( DistanceType )
SearchDetails ( SearchDetailsType )
ShippingOverride ( ShippingOverrideType )
VIN ( string )
VRM ( string )


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

AutoPay ( boolean ) [0..1]
This field is included and set to if true in an Add/Revise/Relist call if the seller wants to require immediate payment from the buyer. If this field is set to false or not included, the seller is not requesting immediate payment.

Note that this field may be set to true, but that does not necessarily mean that the buyer will be required to pay right away. For example, immediate payment is not currently applicable to auctions items won in a competitive bidding process or to items where the buyer and seller negotiated the price through the Best Offer feature. Immediate payment is also not applicable to listings where the payment happens offline between the buyer and seller.
See the Field Index to learn which calls use AutoPay.

AvailableForPickupDropOff ( boolean ) [0..1]
This field is only returned if true, and indicates that the 'Click and Collect' feature is available for this item. With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK, Australia, and Germany sites, and then pick up their order from the nearest 'eBay Collection Point'. Note that an item may be eligible for Click and Collect, but this logistics option will only surface if the prospective buyer is within the vicinity of an 'eBay Collection Point'.

The Click and Collect feature is only available on the eBay UK, Australia, and Germany sites. For more information about Click and Collect, see the Click and Collect home page on the eBay UK site, the Click and Collect home page on the eBay Australia site, or the Click and Collect home page on the eBay Germany site.

Not all categories on the UK, Australia, and Germany 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).

Note: For Click and Collect eligible sellers, the Click and Collect feature can only be enabled at the account level, and then each of the seller's listings will be automatically evaluated for Click and Collect eligibility.
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. Note that the Best Offer feature can be set for auction listings on the US, Canada, UK, Germany, Australia, France, Italy, and Spain marketplaces, but a seller can only use Best Offer or Buy It Now, but not both. Once an auction listing receives a qualifying bid, the Best Offer feature will be turned off and any pending Best Offers or Counteroffers will no longer be valid.

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.

Note: Best Offer is not available for multi-variation listings.
See the Field Index to learn which calls use BestOfferDetails.

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

This field is deprecated. This information is returned in BestOfferDetails.
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.
See the Field Index to learn which calls use BiddingDetails.

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

This field is deprecated.
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]
The eBay Best Price Guarantee price. The Best Price Guarantee program is only available on the eBay Australia marketplace.
See the Field Index to learn which calls use BuyerGuaranteePrice.

BuyerProtection ( BuyerProtectionCodeType ) [0..1]
The enumeration value returned in this field indicates whether an item is eligible for the buyer protection.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
See the Field Index to learn which calls use BuyerProtection.

BuyerRequirementDetails ( BuyerRequirementDetailsType ) [0..1]
This container is returned if the seller has applied one or more buyer requirement criteria to the listing. Buyer requirement settings are managed in the Selling Preferences section of the seller's account in My eBay.
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. (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.
See the Field Index to learn which calls use BuyerResponsibleForShipping.

BuyItNowPrice ( AmountType (double) ) [0..1]
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored.

The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option.

Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.
See the Field Index to learn which calls use BuyItNowPrice.

CategoryMappingAllowed ( boolean ) [0..1]
Note: This field's value now defaults to true if this field is omitted. Previously, the default value was false, so a user had to include this field and set it to true in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID. This boolean field controls whether or not eBay automatically maps outdated Category ID(s) specified in a PrimaryCategory and/or SecondaryCategory container(s) to the updatd Category ID(s) no longer exists in the current category structure: If you pass a value of true in CategoryMappingAllowed or just omit the field, eBay will look up the current Category ID(s) that have replaced the specified Category ID(s). If you pass a value of false, eBay will not do any mapping, and the call may fail if specified Category ID(s) are no longer valid IDs for a eBay leaf category. The new Category ID(s) will be returned in the CategoryID and Category2ID fields (if secondary category is used) of the Add/Revise/Relist call response.

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]
This container identifies the nonprofit organization that will benefit with a percentage of the proceeds from each sale of an item through an auction or fixed-price listing. Charity names and IDs can be found by going to eBay for Charity page and doing a search. The donation percentage can be set in 5 percent increments from 10 percent to 100 percent.

When it comes to revising an auction or fixed-price listing, you can add a benefitting charity (as long as there is at least 12 hours left before end of listing/close of auction), but you cannot remove or change a nonprofit company once one is already established in the original listing.

For Revise calls: The non-profit organization and donation percentage can now be modified in a Revise call as long as there are no active bids on an auction listing, or no pending Best Offers/Counter Offers on a listing.

This container will only be returned in Get calls for charitable listings. Charitable listings are only supported in the US and UK marketplaces.
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.

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.
Note: This field should not be included if ConditionDescriptors are being used. If it is used, a warning will be triggered and the field will be dropped from the listing.
See the Field Index to learn which calls use ConditionDescription.

ConditionDescriptors ( ConditionDescriptorsType ) [0..1]
This container is used in Add/Revise/Relist/Verify listing calls to designate the condition descriptors for the listing. It is also returned in GetItem to indicate the condition descriptors applied to the listing.
Important: For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, Condition ID 2750 can be used to specify the card as a Graded card and Condition ID 4000 can be used to specify the card as an Ungraded card. If either of these condition IDs are used, the seller is required to use the ConditionDescriptors container to provide one or more applicable Condition Descriptor name-value pairs.

Beginning on October 23rd, 2023, trading card listings in the affected categories must either use Condition ID 2750 or Condition ID 4000, and no other item conditions will be accepted. These Condition IDs and the ConditionDescriptors container will be required for all new listings. If not provided after this date, the following calls will fail: AddItem, AddFixedPriceItem, AddItems, VerifyAddItem, and VerifyAddFixedPriceItem.

By January 22, 2024, all existing listings must be modified with either Condition ID 2750 or Condition ID 4000 and applicable ConditionDescriptors name-value pairs. This adds ReviseItem, ReviseFixedPriceItem, RelistItem, RelistFixedPriceItem, and VerifyRelistItem calls to the requirement.
See the Field Index to learn which calls use ConditionDescriptors.

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.
Note: This field will stop being returned in order management calls on January 31, 2024.
See the Field Index to learn which calls use ConditionDisplayName.

ConditionID ( int ) [0..1]
This is a numeric identifier for an item's condition. All numeric Condition ID values map to an item condition string value. For example, numeric identifier 1000 maps to New condition.
Important: For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, Condition ID 2750 can be used to specify the card as a Graded card and Condition ID 4000 can be used to specify the card as an Ungraded card. If either of these condition IDs are used, the seller is required to use the ConditionDescriptors container to provide one or more applicable Condition Descriptor name-value pairs. See the ConditionDescriptors field description for more information.

Beginning on October 23rd, 2023, trading card listings in the affected categories must either use Condition ID 2750 or Condition ID 4000, and no other item conditions will be accepted. These Condition IDs and the ConditionDescriptors container will be required for all new listings. If not provided after this date, the following calls will fail: AddItem, AddFixedPriceItem, AddItems, VerifyAddItem, and VerifyAddFixedPriceItem.

By January 22, 2024, all existing listings must be modified with either Condition ID 2750 or Condition ID 4000 and applicable ConditionDescriptors name-value pairs. This adds ReviseItem, ReviseFixedPriceItem, RelistItem, RelistFixedPriceItem, and VerifyRelistItem calls to the requirement.
Most eBay listing categories require an item condition, but a few eBay categories do not (such as Digital Gift Cards or Antiques categories). To verify if the listing category requires an item condition, and if so, what are the supported item condition and ConditionID values, you can call GetCategoryFeatures. In this GetCategoryFeatures call, you'd pass in the listing CategoryID value and two FeatureID fields - one of these fields set to ConditionEnabled, and the other field set to ConditionValues.

In the GetCategoryFeatures response, look at the Category.ConditionEnabled to see if item condition is required for the category. Then look at the Category.ConditionValues container in the response for the full list of Condition IDs that you can pass in through the ConditionID field of an Add/Revise/Relist/Verify call. Note that the Condition.DisplayName value in the response is the actual condition value that will appear in the actual eBay listing.

If you pass in a ConditionID value that is not valid for the category, or if you don't pass in a ConditionID value at all for a category that requires it, the listing request fails.

If you are listing in two categories (using a secondary category), it is the primary listing category that determines which ConditionID values are supported.

For Revise/Relist calls: In most cases, you can change the ConditionID value (if applicable/warranted), with the exception being an auction listing that has one or more bids, or any listing that is scheduled to end in 12 hours or less.

For GetItem: The ConditionID value is always returned if set for the listing. GetItem also returns the item condition string value in the ConditionDisplayName field.

Note: On the US, Canada, UK, Germany, France, Italy, and Australia marketplaces, condition ID 2500 ('Seller Refurbished') can no longer be used in numerous categories. See Category and marketplace support for the eBay Refurbished Program for the full list. In these categories, the 'Seller Refurbished' item condition has been replaced by one of three new refurbished values, which include condition ID 2010 ('Excellent - Refurbished'), condition ID 2020 ('Very Good - Refurbished'), and condition ID 2030 ('Good - Refurbished'). To use any of these new refurbished item conditions, sellers must go through an application and qualification process. Any seller who is not eligible to use these new refurbished item conditions in these three categories will be blocked if they try to create a new listing or revise an existing listing with any of these three new item conditions. Sellers who are not eligible to list with the new refurbished item conditions, will need to use another item condition supported in these categories, such as condition ID 3000 ('Used').

Any seller that is interested in eligibility requirements to list with any refurbished item condition, including condition ID 2000 ('Certified - Refurbished'), should see the eBay Refurbished Program page in Seller Center.
Note: This field will stop being returned in order management calls on January 31, 2024.
See the Field Index to learn which calls use ConditionID.

Country ( CountryCodeType ) [0..1]
This two-digit enumeration value indicates the country of the seller's registration address. CountryCodeType defines the supported values. The GeteBayDetails call can also be used (include the DetailName field and set its value to CountryDetails) to see the full list of supported country codes.

In an Add/Revise/Relist/Verify call, this field is required.
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]
Not used by any call.

This field is deprecated, and should not longer be used.
See the Field Index to learn which calls use CrossPromotion.

Currency ( CurrencyCodeType ) [0..1]
In an Add/Revise/Relist/Verify call, this required three-digit enumeration value defines the currency associated with the listing site. The item price and all costs passed in the call request will be using this currency. Similarly, the listing fees and other cost-related data will be using this currency. Since the Trading API can only be used for a select number of eBay sites, only a subset of values are supporting when adding/revising/relisting an item. These supported values are discussed in the top section of CurrencyCodeType.

In 'Get' calls, it is possible that any of the values in CurrencyCodeType may appear, as some cost-related fields will show the buyer's currency type.
See the Field Index to learn which calls use Currency.

CustomPolicies ( CustomPoliciesType ) [0..1]
This container is used to apply one or more custom policies to the listing by specifying custom policy IDs. Custom policies include Product Compliance and Take-Back Policies. For more information, see the Custom Policies page for your site (for example, https://www.ebay.fr/help/selling/custom-policies/custom-policies?id=5311). This container is supported by a limited number of sites and specific categories. Use the getExtendedProducerResponsibilityPolicies method of the Sell Metadata API to retrieve valid categories for a site. To create and manage custom policies, use the custom_policy resource of the Account API.
See the Field Index to learn which calls use CustomPolicies.

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. However, a seller can not use any active content in their listing description. Active content includes animation or video via JavaScript, Flash, plug-ins, or form actions. All active content will be blocked/removed from a listing. Removing/blocking active content will lead to faster load times of listings, make listings more mobile-friendly, improve SEO performance, and lead to a more secure eBay Marketplace.

Note: To ensure that their listing description is optimized when viewed on mobile devices, sellers should strongly consider using eBay's View Item description summary feature when listing their item. Using HTML div and span tag attributes, this feature allows sellers to customize and fully control the listing description that is displayed for prospective buyers when viewing the item on a mobile device. The listing description on mobile devices is limited to 800 characters, and whenever the listing description exceeds this limit, eBay uses a special algorithm to derive the best possible description within the 800-character limit. However, due to some description content being removed, it is definitely not ideal for the seller, and could possibly lead to a bad buyer experience and a Significantly not as described (SNAD) case, since the buyer may not get complete details on the item. See the eBay help page for more details on using the HTML div and span tags, and for more tips on creating listings that are mobile-friendly, see this Best practices document.
In the listing description, sellers are only allowed to provide links to product videos, freight shipping services, or other legally required information, and when providing these links in the listing description, the secure 'https' protocol must be used instead of 'http'. In addition, any valid links to sites outside of eBay should use the target="_blank" attribute in the a href tag so a new browser window will be loaded when the link is clicked instead of buyers being redirected off of eBay. For more information on using links in the listing description, see eBay's Links policy. For more information about the stronger security standards that eBay is using, see the Use secure HTTPS for enhanced browser security topic in the 2018 Fall Seller Update. The getListingViolations method of the Compliance API can be used to see if any of the seller's active listings are not 'HTTPS' compliant.

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 the PictureURL field: https://pics.ebay.com/aw/pics/dot_clear.gif. See Add pictures in the Trading API User Guide.

This field is conditionally required for all listings. The exception is when the seller specifies a product identifier, such as a GTIN or ePID, through the ProductListingDetails container and a product match is found in the eBay product catalog. If a matching product is found in the eBay product catalog, the item description will be created automatically (as long as the ProductListingDetails.IncludeeBayProductDetails value is true).
See the Field Index to learn which calls use Description.

DescriptionReviseMode ( DescriptionReviseModeCodeType ) [0..1]
This field is conditionally required if the listing is being revised through a Revise call, and the Item.Description field is one of the fields being changed. The enumeration value passed in this field specifies whether the text provided in the Item.Description field will prepend, append, or replace the existing text in the current Item.Description field.
See the Field Index to learn which calls use DescriptionReviseMode.

DigitalGoodInfo ( DigitalGoodInfoType ) [0..1]
This container is used in Add/Revise/Relist/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]
This field can be included and set to true in an Add or Revise call if the seller wishes to disable all buyer requirements (that are set in the seller's account) for the listing. (from Item.BuyerRequirementDetails or Buyer requirements preferences in My eBay) are ignored.

This field will only be returned in 'Get' calls if true.
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, Spain, and Ireland 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. STP is intended for eBay partners and their sellers only.

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.

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

Note: If the seller opts into the eBay Guaranteed Delivery feature and wants to make a listing eligible for eBay Guaranteed Delivery, the DispatchTimeMax value must be set to 0 or 1 (days) and the cumulative value of DispatchTimeMax plus the transit time of the shipping service (returned in ShippingServiceDetails.ShippingTimeMax field of GeteBayDetails) must be 4 business days or less to be eligible for this feature. See the eBay Guaranteed Delivery page in Seller Center for more information on this program. The eBay Guaranteed Delivery feature is only available on the US and Australia marketplaces.
For Add/Revise/Relist 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 'handling' days. For a list of allowed values on each eBay site, use DispatchTimeMaxDetails in GeteBayDetails. Supported handling times for most sites in most categories range from 0 (same-day handling) to 3 business days, but this can vary by site. Some categories on some sites support longer handling times, and this generally comes into play with extremely large items where freight shipping may be required.

This field is required whenever flat-rate or calculated shipping is used, but does not apply when there is no shipping involved, which is the case for digital gift card listings, or any orders where local pickup is available and this option is selected by the buyer.

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.

This field is deprecated, and should no longer be used.
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.
See the Field Index to learn which calls use eBayNotes.

eBayPlus ( boolean ) [0..1]
eBay Plus is a premium account option for buyers, which provides benefits such as fast and free domestic shipping, and free returns on selected items. To offer this feature to buyers, sellers must opt in to eBay Plus, and their selling status must be 'Above Standard' or above.

Note: Currently, eBay Plus is only available to buyers on the Germany and Australia marketplaces, and this field should only be used by sellers selling eligible items in Germany.

In Australia, the seller has no control/responsibility over setting the eBay Plus feature for a listing. Instead, eBay will evaluate/determine whether a listing is eligible for eBay Plus. Due to this fact, an Australian seller will also get the 21919431: This listing isn't eligible for eBay Plus. warning message in an add/revise/relist call, even though eBay may ultimately set the eBay Plus feature on the listing if the item is eligible.

In an add/revise/relist call, a seller on the Germany site must include this field and set its value to true. If the seller is not eligible for/opted in to eBay Plus and/or the listing category or item does not qualify for eBay Plus, a warning message will be returned to the seller in the response indicating this. In addition to the seller, listing category, and item being eligible for eBay Plus, the seller must also set/commit to the following for the listing:
  • Listing format must be fixed-price.
  • Same-day or one-day handling (DispatchTimeMax set to 0 or 1).
  • A free, next-day shipping option offered.
  • A return policy that offers a 30-day (or longer) return period.
If this field is returned as true in a 'Get' call, it indicates that the item is eligible for eBay Plus treatment, but eBay Plus will only come into play if the buyer is subscribed to eBay Plus.
See the Field Index to learn which calls use eBayPlus.

eBayPlusEligible ( boolean ) [0..1]
If this field is returned as true, this item 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 and free domestic shipping and free returns on selected items. eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Among other requirements, sellers must commit to next-day delivery of those items.

Note: Currently, eBay Plus is available only to buyers in Germany and Australia marketplaces.
See the Field Index to learn which calls use eBayPlusEligible.

EligibleForPickupDropOff ( boolean ) [0..1]
For 'Click and Collect' eligible sellers, this field was once used to set 'Click and Collect' eligibility at the listing level. However, now the seller can only opt in to 'Click and Collect' at the account level, and then each of their listings will be automatically evaluated for 'Click and Collect' eligibility.

Note: Until this field is fully deprecated in the Trading WSDL (and in Add/Revise/Relist/Verify calls), it can still be used, but it will have no functional affect. However, if set in an Add/Revise/Relist/Verify call, it will get returned in GetItem, but it won't be a true indicator if the item is available for the 'Click and Collect' logistics type. Instead, the Item.AvailableForPickupDropOff field should be referenced to see if the item is available for 'Click and Collect'.
See the Field Index to learn which calls use EligibleForPickupDropOff.

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

ExtendedProducerResponsibility ( ExtendedProducerResponsibilityType ) [0..1]
This container is used to provide the eco-participation fee for a product. Use the getExtendedProducerResponsibilityPolicies method of the Sell Metadata API to retrieve categories that support eco-participation fee for a specified marketplace."
For GetItem calls, this container is only returned to the listing owner, if the container is available.
See the Field Index to learn which calls use ExtendedProducerResponsibility.

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.

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]
The unique identifier for a secondary category that eBay has added as a free promotion. You cannot add this yourself. This container is only returned if the item was listed in a single category and eBay added a free secondary category.
See the Field Index to learn which calls use FreeAddedCategory.

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

This field is deprecated.
See the Field Index to learn which calls use GetItFast.

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

This field is deprecated.
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]
This value indicates the number of page views that a listing has received in the last 30 days.

We recommend that you use the getTrafficReport method of the Analytics API to return user traffic details received by a seller's listings. This RESTful method returns metrics such as click-through rate, listing impressions, listing views, sales conversion rate, and the number of completed transactions.

Note: This field is only returned to authorized applications.
See the Field Index to learn which calls use HitCount.

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

IntegratedMerchantCreditCardEnabled ( boolean ) [0..1]
This field is no longer applicable as eBay sellers can no longer use iMCC gateway accounts to handle buyer payments.
Note: This field will stop being returned in order management calls on January 31, 2024.
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.

If a seller will be converting an existing eBay listing into the new Inventory model using the bulkMigrateListings call of the Inventory API, the InventoryTrackingMethod value must be set to ItemID (default value), but the item must also have a SKU value (Item.SKU or Variation.SKU) associated with it. For GetItem and related calls: Only returned when the value is SKU; not returned when the value is ItemID.
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.

IsItemEMSEligible ( boolean ) [0..1]
If true, the item is eligible for shipping managed by eBay; false, the item is not eligible for shipping managed by eBay.
See the Field Index to learn which calls use IsItemEMSEligible.

IsSecureDescription ( boolean ) [0..1]
This boolean field indicates whether or not the listing description is HTTPS secure/compliant. To be HTTPS secure/compliant, the Item.Description field may not contain any links to site pages that use the HTTP (and not HTTPS) protocol. This field will be returned with each listing that is found unless one or more OutputSelector fields are used and Item.IsSecureDescription is not one of the values passed in to one of these fields.

If this field is returned as true, the listing is HTTPs secure/compliant, and the whole listing description will appear on the View Item page for the listing. If this field is returned as false, the listing is not HTTPs secure/compliant, and only a partial/brief listing description will appear on the View Item page for the listing, with a link to the full listing description that will load in another tab.

If the listing description is not HTTPS compliant, the fix is to call ReviseItem or ReviseFixedPriceItem and update the Item.Description field, removing all links to HTTP pages.

For more information about why eBay made this change, please see the Policy Updates page of the Fall 2017 Seller Updates page.
See the Field Index to learn which calls use IsSecureDescription.

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.

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.

See the Field Index to learn which calls use ItemCompatibilityList.

ItemID ( ItemIDType (string) ) [0..1]
The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified.

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. Your code should be prepared to handle IDs of up to 19 digits.
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]
This container is a list of Item Specific Name/Value pairs used by the seller to provide desciptive details of an item in a structured manner.

If creating, revising, or relisting an item with an Add, Revise, or Relist call, it is recommended that you use the getItemAspectsForCategory method of the Taxonomy API to retrieve mandatory and recommended Item Specifics for a category.

For ReviseItem only: When you revise a listing, if an auction listing has one or more bids and ends within 12 hours, you cannot change or add Item Ppecifics. If the auction 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 included.

If your listing is in a eBay product catalog-enabled category, certain Name/Value pairs will be accepted as product identifying information. The Name can be Brand, MPN, or a Global Trade Item Number (GTIN). GTINs are a set of globally recognized identifiers, including EAN, ISBN, and UPC. However, the Values provided for these Names must comply with eBay's constraints or they will not be recognized as product identifiers. The Value for Brand must be an actual brand name (except that if the item is not branded, Value can be Unbranded.) The Value for Brand or MPN cannot contain only special characters (e.g. %$*#@). All GTINs must comply with international formatting standards. For more details, see Item Specifics.

If the ProductListingDetails container in an Add/Revise/Relist call is successfully used to find and use an eBay catalog product to create/revise listing, the seller should not remove or change the value of any Item Specific name or value that is defined as part of the eBay catalog product definition.

Note: If a listing is associated with an eBay catalog product, the seller does not need to pass in any Item Specifics that are already defined in the eBay catalog product. Sellers can make a call to the getItemAspectsForCategory method of the Taxonomy API to see if the category supports any 'instance aspects', which can be thought of as Item Specifics that are unique to the specific item that is being listed. Instance aspects are indicated if the corresponding aspectApplicableTo field of the getItemAspectsForCategory response shows a value of ITEM (and not PRODUCT). Many categories support the following instance aspects: Custom Bundle, Bundle Description, Modified Item, Modification Description, and California Prop 65 Warning. These instance aspects allow the seller to provide more information about product bundles or modified products in a structured way. Depending on the category, there are other instance aspects as well. 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 Item Specific, eBay drops the condition Item Specific.) For GetItem: This list is returned only when you specify IncludeItemSpecifics in the request (and the seller included Item Specifics in their listing).

To delete all Item Specifics when you revise or relist, specify Item.ItemSpecifics in DeletedField, and don't pass ItemSpecifics in the request.
See the Field Index to learn which calls use ItemSpecifics.

LeadCount ( int ) [0..1]
Specifies the number of leads (emails) buyers have posted about the item. You must be the seller of the item to retrieve the lead count.
See the Field Index to learn which calls use LeadCount.

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

This field is deprecated.
See the Field Index to learn which calls use LimitedWarrantyEligible.

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.

In an Add/Revise/Relist call, this container is used to set the Best Offer Auto-Accept and Best Offer Auto-Decline threshold values.
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.

Note: As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions:
  • The following eBay Motors US categories are exempt from this change: Cars & Trucks (6001), Motorcycles (6024), Other Vehicles & Trailers (6038), Boats (26429), Powersports (66466).
  • All child categories under Cars, Motorcycles & Vehicles (9800) categories on the eBay UK and eBay Italy sites are also exempt from this change.
If any other listing duration value besides GTC is specified in this field, it will be ignored, and GTC will be used instead.
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.

You can add a listing upgrade when you revise a listing, but you cannot remove a listing upgrade. When you relist an item, use DeletedField to remove a listing upgrade.
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 selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value).

If this field is not included in an AddItem, AddItems, or VerifyAddItem call, the listing type defaults to auction

For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings.

This field is not applicable to Revise calls because the selling format of active listings cannot be changed.
See the Field Index to learn which calls use ListingType.

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

Note: This field is no longer applicable as eBay Live Auctions are no longer being held as of September 1, 2018. If this field is used in an Add/Revise/Relist call, it will be ignored and dropped.
See the Field Index to learn which calls use LiveAuction.

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

This field is deprecated.
See the Field Index to learn which calls use LocalListing.

Location ( string ) [0..1]
Indicates the geographical location of the item (along with the value in the Country field). 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 motors vehicle listings, the value provided in the Location field 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.
See the Field Index to learn which calls use Location.

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

LotSize ( int ) [0..1]
A lot is a set of two or more similar items included in a single listing that must be purchased together in a single order line item. The Item.LotSize value is the number of items in the lot. This field is required if two or more items are including in one listing.

Lots can be used for auction and fixed-price listings. Lot items can be listed only in lot-enabled categories. Call GetCategories to determine if a category supports lots. If the returned CategoryArray.Category.LSD (LotSize Disabled) value is true, the category does not support lots.
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 the Car category listings on the UK site.
See the Field Index to learn which calls use MechanicalCheckAccepted.

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.

This field is deprecated.
See the Field Index to learn which calls use PartnerCode.

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

This field is deprecated.
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]
This container is used in an Add/Revise/Relist/Verify call if the seller is selling a motor vehicle. It is used by the seller to specify the amount of the initial deposit, and the due dates for the deposit and the full payment for a motor vehicle listing.

Note: If you are using business policies with your listing, the details set up in this container will instead be set up via the payment business policy. Payment business policies are associated with the listing via the SellerProfiles.SellerPaymentProfile container.
This container will only be returned in 'Get' calls for motor vehicle listings where an initial deposit is required for that vehicle.
See the Field Index to learn which calls use PaymentDetails.

PaymentMethods ( BuyerPaymentMethodCodeType ) [0..*]

For Add/Revise/Relist calls: A PaymentMethods field is required for each offline payment method supported by the seller for the listing.
Note: Sellers no longer have to specify any electronic payment methods for listings, so one or more PaymentMethods fields will only be needed for listings that require/support payments off of eBay's platform. If an electronic payment is supplied in a PaymentMethods field, a warning will be triggered and the payment method will be dropped. Note: If you are already referencing a payments business policy in an Add/Revise/Relist call with the SellerProfiles.SellerPaymentProfile container, no PaymentMethods fields will be needed, as these settings will already be set in the payments business policy. Payment methods are not applicable to any classified ad listings, as any agreement and payment is handled off of the eBay platform.

For Get calls that return PaymentMethods fields : One or more PaymentMethods fields will only be returned if the seller set one or more offline payment methods for the listing.
Note: This field will stop being returned in order management calls on January 31, 2024.
See the Field Index to learn which calls use PaymentMethods.

PayPalEmailAddress ( string ) [0..1]
This field is no longer applicable, and should not be used.
See the Field Index to learn which calls use PayPalEmailAddress.

PickupInStoreDetails ( PickupInStoreDetailsType ) [0..1]
This container is used in Add/Revise/Relist/Verify listing calls by the seller to enable a listing with the 'In-Store Pickup' feature. The 'In-Store Pickup' feature is only available to a limited number of large retail merchants in the US, Canada, UK, Germany, and Australia marketplaces.

This container is returned in the 'Get' calls if the listing is enabled with the In-Store Pickup feature.
See the Field Index to learn which calls use PickupInStoreDetails.

PictureDetails ( PictureDetailsType ) [0..1]
This container consists of the data associated with photos within the listing. Sellers can have up to 24 pictures in almost any category at no cost. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors). These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol.

It is required that all listings have at least one picture.
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.

Note: As of late January 2020, the displayed postal code returned in GetItem is now masked to all users except for the seller of the item. Different countries will mask postal/zip codes in slightly different ways, but an example would be 951**.
See the Field Index to learn which calls use PostalCode.

PrimaryCategory ( CategoryType ) [0..1]
This container is used in an Add/Revise/Relist call to set the primary listing category. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, listing category, and stock photo defined in the catalog product is used to create the listing.

If you do not know the appropriate eBay category for your product, you can use the GetSuggestedCategories call. Once you know your category, and want to know which listing features it supports, you can use the GetCategoryFeatures call. To discover required, recommended, and optional Item Specifics for a category, use the getItemAspectsForCategory method of the Taxonomy API.

If you do use an eBay catalog product, it is advised that you do not include this field, as any primary category ID you specify in this field may get dropped if this category is different than the primary category defined in the eBay catalog product.

For ReviseItem only: When revising a listing, you can change the primary category only if an auction listing has no bids or a multiple-quantity, fixed-price listing has no sales, and the listing does not end within 12 hours. If you change the listing category, any Item Specifics that were previously specified may be dropped from the listing if they aren't valid for the new category.

When you list an event ticket on the US site, you must specify one of the leaf categories under the Tickets & Experiences meta category.
See the Field Index to learn which calls use PrimaryCategory.

PrivateListing ( boolean ) [0..1]
A true value in this field indicates that the listing is private. Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users.

For ReviseItem/ReviseFixedPriceItem: The seller will not be able change this setting if the listing has any pending bids, any pending best offers, previous sales (for multiple-quantity, fixed-price listing), or if the listing will end within 12 hours.
See the Field Index to learn which calls use PrivateListing.

PrivateNotes ( string ) [0..1]
A note that a user makes on an item from their My eBay account. GetMyeBayBuying and GetMyeBaySelling return this field, and only if you pass in the IncludeNotes field in the request, and set its value to true. This field will only be returned if set for an item, and only returned 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).
See the Field Index to learn which calls use PrivateNotes.

ProductListingDetails ( ProductListingDetailsType ) [0..1]
This container is used to provide one or more product identifiers for a product, and if desired by the seller, eBay will use the identifier(s) of the product to try to match it to a defined product in the eBay catalog. If a seller's product is matched to an eBay catalog product, the product details associated with that catalog product will be prefilled for the listing. Product details defined for a catalog product include the product title, product description, product aspects, and stock image(s) of the product (if available).

In some eBay categories, one or more product identifier types (e.g. UPC or ISBN) may be required, but the category may not have any eBay catalog products defined, or the category does not allow listings to be created using a catalog product. Note that the GetCategoryFeatures call can be used to retrieve supported/required product identifier types.

Note: If a product identifier type is required, the corresponding field must be used, even if the seller is not interested in finding an eBay catalog product match. A large percentage of eBay US categories require one or more product identifier types when listing an item. See the Structured Data - Product Identifiers help page for more information on which eBay US categories require which product identifier types. If known, an ePID (specified through the ProductReferenceID field) is always the best bet to find an eBay catalog product match, although an EAN, ISBN, UPC, or Brand/MPN pair can also be used in an attempt to find a catalog product match. If a Brand/MPN pair is required for the product, these values must be input through the BrandMPN container.
When you use ProductListingDetails, in an Add/Revise/Relist call, you must specify at least one GTIN, a ProductReferenceID (also known as an ePID), or a Brand/MPN pair. If you specify more than one GTIN value, eBay uses the first one that matches a product in eBay's catalog.

For ReviseItem and RelistItem only: When you revise a listing, if it has bids or it ends within 12 hours, you cannot change the product identifier and you cannot remove existing product listing details 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.
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]
For AddItem family of calls: The Quantity value for auction 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 this field is not included when creating a new fixed-price listing, quantity defaults to '1'. 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 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 three 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.

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

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.
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.
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.

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

ReasonHideFromSearch ( ReasonHideFromSearchCodeType ) [0..1]
This field is returned only when 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.

This field is deprecated.
See the Field Index to learn which calls use RegionID.

Regulatory ( RegulatoryType ) [0..1]
This container is used by the seller to provide Energy Efficiency Label information, hazardous material related information, and the repair score for the listing.
See the Field Index to learn which calls use Regulatory.

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: A new listing will not return this field.
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.
See the Field Index to learn which calls use RelistLink.

RelistParentID ( long ) [0..1]
The identifier of the original listing that contained the item before the item was relisted. This field is only returned for an item that was relisted.
See the Field Index to learn which calls use RelistParentID.

ReservePrice ( AmountType (double) ) [0..1]
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder.

As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit.

In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item.
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).
Note: As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the ReturnPolicy container or through a return business policy that is referenced through the SellerProfiles.SellerReturnProfile container.
Note: If you are using a return business policy set up through My eBay or via the Account API, then you should not populate the fields in this ReturnPolicy container. Instead, indicate your return policy using the SellerProfiles.SellerReturnProfile container.

However, if you do not configure a return policy, all the fields in this ReturnPolicy container that are marked conditional must be populated in your request.

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.

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.

Note: The GeteBayDetails call can be used to retrieve site-wide return policy metadata, but it is recommended that sellers use the GetCategoryFeatures call instead, as this call was recently updated to retrieve category-level metadata for both domestic and international return policies.
Note: In May 2018, eBay added the ability to create a separate international return policy for items that are shipped to international customers. If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead for international returns. For more information on setting separate domestic and international return policies, see the International returns policy help topic. For the international equivalent of this field, see the InternationalRefundMethodValues field.
See the Field Index to learn which calls use ReturnPolicy.

ReviseStatus ( ReviseStatusType ) [0..1]
This container is returned if a listing has been revised in any way since it first became active. One or more boolean fields will be returned under this container based on the type of revision(s) that occured, including a general revision, a price change, or a feature added or removed.
See the Field Index to learn which calls use ReviseStatus.

ScheduleTime ( dateTime ) [0..1]
Allows the user to specify a time in the future 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 (listing has yet to go live).

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

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

This field is deprecated.
See the Field Index to learn which calls use SearchDetails.

SecondaryCategory ( CategoryType ) [0..1]
The unique identifier for a secondary category. This field is only applicable if the seller decides to list the item under 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 listing category as a value category (see ValueCategory in GetCategoryFeatures), and that listing category will be the seller's primary category, the seller will not be able to list their item in a secondary category. If a seller's request payload includes a primary or a secondary category that is designated as a value category, then eBay drops the SecondaryCategory ID and only lists the item in the category specified with the PrimaryCategory ID. Also, if the listing request includes Item Specifics (in ItemSpecifics) that are associated with the SecondaryCategory, eBay drops those values as well when the SecondaryCategory is dropped. 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 within 12 hours of the listing's scheduled end time, you can only add or change the secondary category when an auction listing has no active bids or a multiple-quantity, fixed-price listing has no items sold. If you change the secondary category, any corresponding Item Specifics that were previously specified may be dropped from the listing if they aren't valid for the category.

For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field.
See the Field Index to learn which calls use SecondaryCategory.

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

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

SellerContactDetails ( AddressType ) [0..1]
This container is used by sellers of Classified Ad listings to provide contact information.
See the Field Index to learn which calls use SellerContactDetails.

SellerProfiles ( SellerProfilesType ) [0..1]
This container is used if the seller would like to use/reference business policies to create, revise, relist, or verify their listing. The seller's account must be opted in to business policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy must be specified and applied to the listing. If the seller's account is not opted in to business policies, that seller may not use this container. Sellers must opt-in to business policies through My eBay or by using the optInToProgram call of the eBay Account API.

If business policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request.
Note: To make sure that the shipping cost override and policies are set correctly on an item (that is using business policies and has one or more shipping service cost overrides set up), the Item.SellerProfiles.SellerShippingProfile container and the Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride container(s) must be included, even if no changes are being made. This container is only returned in 'Get' calls if business policies are set for the listing, and the person making the API call is the seller of 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 4148).
See the Field Index to learn which calls use SellerProvidedTitle.

SellerVacationNote ( string ) [0..1]
This field is returned if the seller of the item is currently on vacation and has configured a custom message to display to potentioal buyers through Time Away settings.

Note: There are two Time Away modes - Pause Sales and Allow Sales. If seller is in the Pause Sales mode, all fixed-price listings for that seller will be hidden from search results during the span of the seller's vacation.
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, the current high bidder, quantity sold, current price, and listing status.
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.

Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, none of the fields under the ShippingDetails container are necessary. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container.

If you do not use a fulfillment business policy, many of the fields under this ShippingDetails container become required in your request.

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, 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 any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform.

Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
  • Either omit the entire ShippingDetails container, or pass in an empty ShippingDetails container - <ShippingDetails/>
  • Pass in one ShipToLocations field, with its value set to None - <ShipToLocations>None</ShipToLocations>

For GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned.
See the Field Index to learn which calls use ShippingDetails.

ShippingOverride ( ShippingOverrideType ) [0..1]
Not used by any call.

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

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 shipping business policy 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 shipping business policy.
Note: To make sure that the shipping cost override and policies are set correctly on an item (that is using business policies and has one or more shipping service cost overrides set up), the Item.SellerProfiles.SellerShippingProfile container and the Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride container(s) must be included, even if no changes are being made. 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 shipping business policy.

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.

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.

Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, the ShipToLocations field should not be used in the request. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container.
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.

Note: The ShipToLocations and ShippingDetails.ExcludeShipToLocation containers are not applicable for motor vehicle listings on the US, CA, or UK marketplaces. If these containers are sent in the request, they are ignored and a warning is returned.
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).

Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
  • Either omit the entire ShippingDetails container, or pass in an empty ShippingDetails container - <ShippingDetails/>
  • Pass in one ShipToLocations field, with its value set to None - <ShipToLocations>None</ShipToLocations>
See the Field Index to learn which calls use ShipToLocations.

Site ( SiteCodeType ) [0..1]
The name of the eBay listing site. 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).
See the Field Index to learn which calls use Site.

SKU ( SKUType (string) ) [0..1]
A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus

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

If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request.

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 GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing.
See the Field Index to learn which calls use SKU.

StartPrice ( AmountType (double) ) [0..1]
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 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): 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.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.
See the Field Index to learn which calls use StartPrice.

Storefront ( StorefrontType ) [0..1]
This container provides details about the seller's eBay store.

In an Add/Revise/Relist call, the seller can include this container to set/change which customized eBay store category that the item will be placed in.

For 'Get' calls, this container is returned if the seller of the item has an eBay store.
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).

When you revise a item, you can add, change, or remove the subtitle.
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.

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

Title ( string ) [0..1]
This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing.

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

The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.
Note: When making a GetSellerEvents call, this field will be returned masked as ***************** for on-hold listings. Note: When making a GetSellerTransactions or GetMyeBaySelling call, the item ID value of the listing will be returned in this field to indicate that the listing is on hold.
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]
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.

This container will only be returned if price per unit information exists for the listing, and the IncludeItemSpecifics field was included in the call request and set to true.
See the Field Index to learn which calls use UnitInfo.

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 of Trading API or the createOrReplaceSalesTax method of Account API. 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).

Note: As of November 2021, buyers in all US states except for Missouri (and several US territories), will automatically be charged sales tax for purchases, and the seller does not set this rate. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. For more US state-level information on sales tax, see the eBay sales tax collection help topic.
See the Field Index to learn which calls use UseTaxTable.

UUID ( UUIDType (string) ) [0..1]
Use an UUID value to ensure that you only list (or relist) a particular item once. This field can be particularly useful if you are listing many items on a daily basis and/or many items at once with an AddItems call. If your call request does not generate a response, or if you get one or more (blocking) errors, be sure to use the same UUID value when you attempt to list or relist the same item with another call request.

If you pass in a UUID value that has already been used to successfully create or relist an item, you will receive an error message that includes the Item ID for that listing and a boolean value indicating whether the duplicate UUID was sent by the same application.

We recommend that you use the Item.UUID field for add and relist calls (for example, AddItem and RelistItem), but use the Item.InvocationID field instead when using a revise call.

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 of the seller's eBay across all eBay marketplaces.
See the Field Index to learn which calls use UUID.

Variations ( VariationsType ) [0..1]

Variations are similar (but not identical) items in a multiple-variation, 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.
Note: This container will stop being returned in GetItemTransactions on January 31, 2024.
See the Field Index to learn which calls use Variations.

VATDetails ( VATDetailsType ) [0..1]
This container is used in an Add/Revise/Relist call to set the VAT (Value-added Tax) percentage rate that will be charged to buyers when an item is purchased from the listing, and to enable Business Seller-related features.

This container is returned in 'Get' calls only if VAT is applicable to the listing, and unless the person making the 'Get' call owns the listing, only the VATPercent field is returned (if applicable). However, Business Seller-related information will be returned to all users in 'Get' calls under the SellerInfo and BusinessSellerDetails containers.

Note: VAT is not applicable to all countries, including the US. Allowed VAT percentage rates can vary by region/country, so sellers should be aware of the rates they are legally required/allowed to charge. Sellers must be registered as Business Sellers on the site they are selling on in order to use the Business Seller-related fields.
See the Field Index to learn which calls use VATDetails.

VideoDetails ( VideoDetailsType ) [0..1]
This container is used if the seller wants to add a video to their listing. At this time, only one video can be added per listing. The video can be uploaded to eBay using the Media API. See the Media API reference documentation for all of the necessary details to upload videos to eBay.

This container will only be returned in GetItem if the listing contains a video, and the seller of the item is the one making the GetItem call.

Note: Videos can only be attached to listings on supported eBay marketplaces and can only be viewed through supported platforms. See Managing videos in the Selling Integration Guide for a full list of supported marketplaces and platforms.
See the Field Index to learn which calls use VideoDetails.

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, make a call to the getItemAspectsForCategory method of the Taxonomy API to determine applicable Item Specifics (such as 'Hull ID Number' for Boats).

For the US, CA, and CA-FR eBay Motors categories, 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.

GetItem will return this field for motor vehicle listings where the VIN is defined.
See the Field Index to learn which calls use VIN.

VINLink ( string ) [0..1]
GetItem will return this field for motor vehicle listings where the VIN is defined.
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).

GetItem will return this field for motor vehicle listings where the VRM is defined.
See the Field Index to learn which calls use VRM.

VRMLink ( string ) [0..1]
GetItem will return this field for motor vehicle listings where the VRM is defined.
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.
See the Field Index to learn which calls use WatchCount.