Container for Bulk Data Exchange Requests. Defines default or required values for requests in the payload. Container for Bulk Data Exchange Responses. Defines default or required values for requests in the payload. The numeric eBay Site Code for which to route the requests in the payload. E.g. 77 for eBay Germany. BulkDataExchange Yes Default version for each request in the payload. Can be overridden at the request level. BulkDataExchange Yes Authentication information for the user on whose behalf the application is making the request. Only registered eBay users are allowed to make API calls. To verify that a user is registered, your application needs to pass a user-specific value called an "authentication token" in the request. This is equivalent to signing in on the eBay Web site. As API calls do not pass session information, you need to pass the user's authentication token every time you invoke a call on their behalf. All calls require an authentication token, except the calls you use to retrieve a token in the first place. (For such calls, you use the eBay member's username and password instead.) Yes A report that contains price and quantity information for all of the active listings for a specific seller. A seller can use this information to maintain their inventory on eBay. <br><br> The eBay servers read the token information passed in by the seller's application to determine which seller's data to retrieve. <br/><br/> <span class="tablenote"> <strong>Note:</strong> ActiveInventoryReport cannot be issued on its own like an ordinary API call, using an endpoint. This Large Merchant Services call must be invoked as a parameter in a Bulk Data Exchange API call, which will produce a report that can be downloaded using a File Transfer API call. This call has no request type. </span> Reports price and quantity details for a seller's active listings. Trading http://developer.ebay.com/devzone/xml/docs/reference/ebay ReviseInventoryStatus Enables a seller to change the price and quantity of currently active fixed-price items. Can be uploaded in bulk with Large Merchant Services. ReviseFixedPriceItem Enables a seller to change the properties of a single currently active listing. Can be uploaded in bulk with Large Merchant Services. A report that contains all of the active listings for a specific seller. The eBay servers read the token information passed in by the seller's application to determine which seller's data to retrieve. Describes or includes keywords associated with the SKU. ActiveInventoryReport Always Defines and lists a new fixed-price listing (not auction-style listings). The main difference between AddFixedPriceItem and AddItem is that AddFixedPriceItem supports the creation of fixed-price listings only, whereas AddItem supports all listing formats.<br> <br> Also, only AddFixedPriceItem supports multi-variation listings and tracking inventory by SKU. AddItem does not support Variations or InventoryTrackingMethod.<br> <br> See the AddFixedPriceItem documentation for additional information. Defines and lists a new fixed-price item. A fixed-price listing can include multiple identical items. AddItem, AddItems, AddToItemDescription, EndFixedPriceItem, GetItem, GetCategories, RelistFixedPriceItem, ReviseFixedPriceItem, VerifyAddFixedPriceItem ListingAnItem UseTopicAlias ListingItemsIntro UseTopicAlias Pictures UseTopicAlias Variations UseTopicAlias ConsideringBestMatch UseTopicAlias Root container holding all values that define a new fixed-price listing. AddFixedPriceItem Yes Returns the item ID, SKU (if any), listing recommendations (if applicable), the estimated fees for the new listing (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details. Unique identifier for the new fixed-price listing. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddFixedPriceItem Always Item-level SKU for the new listing, if the seller specified Item.SKU in the request. Variation-level SKUs are not returned (see GetItem instead). AddFixedPriceItem Conditionally Starting date and time for the new listing. This value is based on the time the listing was received and processed, or the time the item will be listed if the seller specified Item.ScheduleTime in the request. AddFixedPriceItem Always Date and time when the new listing ends. This is the starting time plus the listing duration. AddFixedPriceItem Always Child elements contain the estimated listing fees for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. eBay.com Fees http://pages.ebay.com/help/sell/fees.html AddFixedPriceItem Always FinalValueFeesAndCredits UseTopicAlias Final Value Fees http://pages.ebay.com/help/sell/fvf.html FeesPerSite UseTopicAlias UsingFeaturePacks UseTopicAlias ID of the primary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or if it has expired with no replacement, CategoryID does not return a value. 10 AddFixedPriceItem Conditionally ID of the secondary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. 10 AddFixedPriceItem Conditionally The nature of the discount, if a discount is applied. AddFixedPriceItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. AddFixedPriceItem Conditionally Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in reqards to Top-Rated Plus listing requirements, Item Specifics, picture requirements, and/or a recommendation to use a product code to list the item, such as a UPC, an EAN, or an ISBN. <br><br> This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>AddFixedPriceItem</b> request, and if at least one listing recommendation exists for the newly created listing. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item based on eBay's listing recommendation(s). AddFixedPriceItem Conditionally Defines a single new item and lists it on a specified eBay site.&nbsp;<b>Also for Half.com</b>. Returns the item ID for the new listing, and returns fees the seller will incur for the listing (not including the Final Value Fee, which cannot be calculated until the item is sold). AddFixedPriceItem, AddItems, AddToItemDescription, GetItem, GetSellerList, RelistItem, ReviseItem, VerifyAddItem ListingAnItem UseTopicAlias ListingItemsIntro UseTopicAlias Specifying Shipping Costs when Creating or Revising a Listing http://developer.ebay.com/DevZone/XML/docs/WebHelp/ManagingShipping-Specifying_Shipping_Costs_when_Creating_or_Revising_a_Listing.html Seller Checklist http://pages.ebay.com/sell/April2009Update/Checklist/ Pictures UseTopicAlias ConsideringBestMatch UseTopicAlias half Root container holding all values that define a new listing. <br> <br> Applicable to Half.com. AddItem Yes Returns the Item ID, SKU (if any), listing recommendations (if applicable), the estimated fees for the new listing (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details. Unique identifier for the new listing. <br> <br> Applicable to Half.com. <br> <br> <span class="tablenote"><b>Note:</b> Although eBay represents Item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store Item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time, and your code should be prepared to handle IDs of up to 19 digits. For more information about Item IDs, see <a href=" http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=468"> Common FAQs on eBay Item IDs and other eBay IDs</a> in the Knowledge Base. </span> 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddItem Always Starting date and time for the new listing. <br> <br> Applicable to Half.com (for Half.com, the start time is always the time the item was listed). AddItem Always Date and time when the new listing ends. This is the starting time plus the listing duration. <br> <br> Applicable to Half.com (for Half.com the actual end time is GTC, not the end time returned in the response). AddItem Always Child elements contain the estimated listing fees for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. <br> <br> Applicable to Half.com, but the values are not applicable to Half.com listings. AddItem Always eBay.com Fees http://pages.ebay.com/help/sell/fees.html FinalValueFeesAndCredits UseTopicAlias Final Value Fees http://pages.ebay.com/help/sell/fvf.html FeesPerSite UseTopicAlias UsingFeaturePacks UseTopicAlias ID of the primary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. <br> <br> Not applicable to Half.com. 10 AddItem Conditionally ID of the secondary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. <br> <br> Not applicable to Half.com. 10 AddItem Conditionally The nature of the discount, if a discount applied. AddItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. AddItem Conditionally Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in reqards to Top-Rated Plus listing requirements, Item Specifics, picture requirements, and/or a recommendation to use a product code to list the item, such as a UPC, an EAN, or an ISBN. <br><br> This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>AddItem</b> request, and if at least one listing recommendation exists for the newly created listing. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item based on eBay's listing recommendation(s). AddItem Conditionally Ends the specified fixed-price listing before the date and time at which it would normally end (per the listing duration). EndItem, RelistFixedPriceItem EndingItemsEarly UseTopicAlias Unique item ID that identifies the item listing that you want to end. <br><br> In the EndFixedPriceItem request, either ItemID or SKU is required. If both are passed in and they don't refer to the same listing, eBay ignores SKU and considers only the ItemID. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) EndFixedPriceItem Conditionally Indicates the seller's reason for ending the listing early. This field is required if the seller is ending the item early and the item did not successfully sell. EndFixedPriceItem Yes The unique SKU of the item being ended. A SKU (stock keeping unit) is an identifier defined by a seller. SKU can only be used to end an item if you listed the item by using AddFixedPriceItem or RelistFixedPriceItem, and you set Item.InventoryTrackingMethod to SKU at the time the item was listed. (These criteria are necessary to uniquely identify the listing by a SKU.) <br><br> In the EndFixedPriceItem request, either ItemID or SKU is required. If both are passed in and they don't refer to the same listing, eBay ignores SKU and considers only the ItemID. <br><br> To remove a SKU when you revise or relist an item, use DeletedField in the revision or relist call. 50 EndFixedPriceIteme> Conditionally Acknowledgement that includes SKU, as well as the date and time the auction was ended due to the call to EndFixedPriceItem. Timestamp that indicates the date and time (GMT) that the specified item listing was ended. EndFixedPriceItem Always If a SKU (stock-keeping unit) exists for the item listing, it is returned in the response. 50 EndFixedPriceIteme> Conditionally Ends the specified item listing before the date and time at which it would normally end per the listing duration.&nbsp;<b>Also for Half.com</b>. AddItem, EndFixedPriceItem, EndItems, RelistItem EndingItemsEarly UseTopicAlias Unique item ID that identifies the item listing to end. <br><br> For Half.com listings, you can either specify ItemID or SellerInventoryID. <br><br> Applicable to Half.com. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) EndItem Yes Indicates the seller's reason for ending the listing early. This field is required if the seller is ending the item early and the item did not successfully sell. <br><br> Applicable to Half.com. EndItem Yes Unique identifier that the seller specified when they listed the Half.com item. For Half.com items, you can either specify ItemID or SellerInventoryID. If you specify both ItemID and SellerInventoryID, they must be for the same item (otherwise an error will occur). <br><br> Applicable only to Half.com. EndItem Conditionally Includes the acknowledgement of date and time the auction was ended due to the call to EndItem. Indicates the date and time (returned in GMT) the specified item listing was ended. Also applicable to Half.com. EndItem Always Contains information about user invoice and related order information. To use this report, you must perform the one-time steps described in <a href="http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1394"> Support Knowledge Base Article - LMS: FeeSettlementReport one time set-up process </a>. <br/><br/> <span class="tablenote"> <strong>Note:</strong> FeeSettlementReport cannot be issued on its own like an ordinary API call, using an endpoint. This Large Merchant Services call must be invoked as a parameter in a Bulk Data Exchange API call, which will produce a report that can be downloaded using a File Transfer API call. This call has no request type. </span> Contains information about user invoice and related order information, such as: fee type, fee amount, item category, order id, transaction id, item id, and item title. Contains information about user invoice and related order information, such as: fee type, fee amount, item category, order id, transaction id, item id, and item title. Some setup steps are required. See the Knowledgebase Article at the following link. Setting Up the FeeSettlementReport http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1394 The invoice identifier is an alphanumeric value that uniquely identifies the invoice for the specified invoice period for the associated customer account. FeeSettlementReport Always site username FeeSettlementReport Always eBay Account Id. FeeSettlementReport Always Beginning date time of invoice period. FeeSettlementReport Always Ending date time of invoice period. FeeSettlementReport Always Date time of billing process (BIP). FeeSettlementReport Always Invoice due date. FeeSettlementReport Always This invoice amount. FeeSettlementReport Always Amount of the previous invoice. The LastInvoiceAmount is included in the report if at least one invoice has already been sent to the user requesting this report. FeeSettlementReport Conditionally The rounding adjustment will be calculated as: the difference between the total individual invoice line items and the total InvoiceAmount plus UsageAdjustment. FeeSettlementReport Always The Usage Adjustment will equal the total unrounded usage fee amounts, multiplied by the tax rate. FeeSettlementReport Always Usage transactions with order information belong to this invoice. FeeSettlementReport Conditionally Usage transactions which can not find the order information belong to this invoice. FeeSettlementReport Conditionally Usage adjustment belong to this invoice. FeeSettlementReport Conditionally Non-usage transactions belong to this invoice. FeeSettlementReport Conditionally Discount transactions belong to this invoice. FeeSettlementReport Conditionally Request that you use to acknowlege that an order has been received. Use the OrderAck job to acknowledge each line item in a SoldReport by order or line item. After you send the first OrderAck call, future SoldReports will only contain unacknowledged orders or line items. <br/><br/> <span class="tablenote"> <strong>Note:</strong> OrderAck cannot be issued on its own like an ordinary API call, using an endpoint. This Large Merchant Services call must be entered one or more times as the payload in a data file that will be uploaded to an eBay server using the File Transfer API, then processed using the Bulk Data Exchange API. This call will fail if you attempt to invoke it directly. </span> Request that you use to acknowlege that an order has been received. An ID that uniquely identifies each order (item or items paid for within the same transaction). OrderAck Yes An ID that uniquely identifies each line item (specifics about a purchased item or SKU) within an order. OrderAck Yes Response to your request that acknowledges each line item of an order. OrderLineItemID is required upon input and always returned in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. OrderAck Always Enables a seller to take a single fixed-price item (or a single multi-item listing) that has ended and re-list it on a specified eBay site. AddFixedPriceItem, RelistItem, ReviseFixedPriceItem, GetCategories Pictures UseTopicAlias UseTopicAlias RelistingItems Relisting Your Item (eBay Web site onine help) http://pages.ebay.com/help/sell/relist.html ConsideringBestMatch UseTopicAlias BestMatchReviseRelist UseTopicAlias Child elements hold the values for item properties that change for the relisted item. Item is a required input. At a minimum, the Item.ItemID property must be set to the ID of the original listing (a listing that ended in the past 90 days). By default, the new listing's Item object properties are the same as those of the original (ended) listing. By setting a new value in the Item object, the new listing uses the new value rather than the original value from the old listing. RelistFixedPriceItem Yes Specifies the name of the field to delete from a listing. See the eBay Trading API guide for rules on deleting values when relisting items. Also see the relevant field descriptions to determine when to use DeletedField (and potential consequences). The request can contain zero, one, or many instances of DeletedField (one for each field to be deleted). DeletedField accepts the following path names, which delete the corresponding nodes:<br> <br> Some data (such as Variation nodes within Variations) can't be deleted by using DeletedFields. See the relevant field descriptions for how to delete such data.<br> <br> Item.ApplicationData<br> Item.AttributeSetArray<br> Item.Charity<br> Item.ConditionID<br> Item.ItemSpecifics<br> Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br> Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br> Item.ListingDesigner.LayoutID<br> Item.ListingDesigner.ThemeID<br> Item.ListingDetails.LocalListingDistance<br> Item.ListingDetails.MinimumBestOfferMessage<br> Item.ListingDetails.MinimumBestOfferPrice<br> Item.ListingEnhancement[Value]<br> Item.PayPalEmailAddress<br> Item.PictureDetails.GalleryURL<br> Item.PictureDetails.PictureURL<br> Item.PostalCode<br> Item.ProductListingDetails<br> Item.SecondaryCategory<br> Item.SellerContactDetails<br> Item.SellerContactDetails.CompanyName<br> Item.SellerContactDetails.County<br> Item.SellerContactDetails.InternationalStreet<br> Item.SellerContactDetails.Phone2AreaOrCityCode<br> Item.SellerContactDetails.Phone2CountryCode<br> Item.SellerContactDetails.Phone2CountryPrefix<br> Item.SellerContactDetails.Phone2LocalNumber<br> Item.SellerContactDetails.PhoneAreaOrCityCode<br> Item.SellerContactDetails.PhoneCountryCode<br> Item.SellerContactDetails.PhoneCountryPrefix<br> Item.SellerContactDetails.PhoneLocalNumber<br> Item.SellerContactDetails.Street<br> Item.SellerContactDetails.Street2<br> Item.ShippingDetails.PaymentInstructions<br> Item.SKU<br> Item.SubTitle<br> These values are case-sensitive. Use values that match the case of the schema element names (Item.PictureDetails.GalleryURL) or make the initial letter of each field name lowercase (item.pictureDetails.galleryURL). However, do not change the case of letters in the middle of a field name. For example, item.picturedetails.galleryUrl is not allowed.<br><br> To delete a listing enhancement like Featured, specify the value you are deleting; for example, Item.ListingEnhancement[Featured]. RelistFixedPriceItem Conditionally Returns the Item ID, SKU (if any), listing recommendations (if applicable), the estimated fees for the relisted item (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details. Unique item ID for the relisted item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) RelistFixedPriceItem Always Item-level SKU for the new listing, if the seller specified Item.SKU in the listing. Variation SKUs are not returned (see GetItem instead). RelistFixedPriceItem Conditionally Child elements contain the estimated listing fees for the relisted item. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. RelistFixedPriceItem Always Date and time the relisting became active on the eBay site. RelistFixedPriceItem Always Date and time when the relisted item ends. This is the starting time plus the listing duration. RelistFixedPriceItem Always ID of the primary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. 10 RelistFixedPriceItem Conditionally ID of the secondary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. 10 RelistFixedPriceItem Conditionally The nature of the discount, if a discount applied. RelistFixedPriceItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. RelistFixedPriceItem Conditionally Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in reqards to Top-Rated Plus listing requirements, Item Specifics, picture requirements, and/or a recommendation to use a product code to list the item, such as a UPC, an EAN, or an ISBN. <br><br> This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>RelistFixedPriceItem</b> request, and if at least one listing recommendation exists for the newly relisted item. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item based on eBay's listing recommendation(s). RelistFixedPriceItem Conditionally Enables a seller to take a single item (or a single multi-item listing) and re-list it on a specified eBay site. AddItem, AddToItemDescription, GetItem, GetItemRecommendations, GetSellerList, RelistFixedPriceItem, ReviseItem UseTopicAlias RelistingItems http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1542 Best practices for relisting items Pictures UseTopicAlias ConsideringBestMatch UseTopicAlias BestMatchReviseRelist UseTopicAlias Child elements hold the values for item properties that change for the item re-list. Item is a required input. At a minimum, the Item.ItemID property must be set to the ID of the listing being re-listed (a listing that ended in the past 90 days). By default, the new listing's Item object properties are the same as those of the original (ended) listing. By setting a new value in the Item object, the new listing uses the new value rather than the corresponding value from the old listing. RelistItem Yes Specifies the name of the field to delete from a listing. See the eBay Web Services guide for rules on deleting values when relisting items. Also see the relevant field descriptions to determine when to use DeletedField (and potential consequences). The request can contain zero, one, or many instances of DeletedField (one for each field to be deleted). DeletedField accepts the following path names, which delete the corresponding nodes:<br><br> Item.ApplicationData<br> Item.AttributeSetArray<br> Item.BuyItNowPrice<br> Item.Charity<br> Item.ConditionID<br> Item.ItemSpecifics<br> Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br> Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br> Item.ListingDesigner.LayoutID<br> Item.ListingDesigner.ThemeID<br> Item.ListingDetails.LocalListingDistance<br> Item.ListingDetails.MinimumBestOfferMessage<br> Item.ListingDetails.MinimumBestOfferPrice<br> Item.ListingEnhancement[Value]<br> Item.PayPalEmailAddress<br> Item.PictureDetails.GalleryURL<br> Item.PictureDetails.PictureURL<br> Item.PostalCode<br> Item.ProductListingDetails<br> Item.SecondaryCategory<br> Item.SellerContactDetails<br> Item.SellerContactDetails.CompanyName<br> Item.SellerContactDetails.County<br> Item.SellerContactDetails.InternationalStreet<br> Item.SellerContactDetails.Phone2AreaOrCityCode<br> Item.SellerContactDetails.Phone2CountryCode<br> Item.SellerContactDetails.Phone2CountryPrefix<br> Item.SellerContactDetails.Phone2LocalNumber<br> Item.SellerContactDetails.PhoneAreaOrCityCode<br> Item.SellerContactDetails.PhoneCountryCode<br> Item.SellerContactDetails.PhoneCountryPrefix<br> Item.SellerContactDetails.PhoneLocalNumber<br> Item.SellerContactDetails.Street<br> Item.SellerContactDetails.Street2<br> Item.ShippingDetails.PaymentInstructions<br> Item.SKU<br> Item.SubTitle<br> These values are case-sensitive. Use values that match the case of the schema element names (Item.PictureDetails.GalleryURL) or make the initial letter of each field name lowercase (item.pictureDetails.galleryURL). However, do not change the case of letters in the middle of a field name. For example, item.picturedetails.galleryUrl is not allowed.<br><br> To delete a listing enhancement like Featured, specify the value you are deleting; for example, Item.ListingEnhancement[Featured]. RelistItem Conditionally Returns the Item ID, SKU (if any), listing recommendations (if applicable), the estimated fees for the relisted item (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details. Unique item ID for the new listing. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) RelistItem Always Child elements contain the estimated listing fees for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. RelistItem Always Date and time the new listing became active on the eBay site. RelistItem Always Date and time when the new listing ends. This is the starting time plus the listing duration. RelistItem Always ID of the primary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. 10 RelistItem Conditionally ID of the secondary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. 10 RelistItem Conditionally The nature of the discount, if a discount applied. RelistItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. RelistItem Conditionally Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in reqards to Top-Rated Plus listing requirements, Item Specifics, picture requirements, and/or a recommendation to use a product code to list the item, such as a UPC, an EAN, or an ISBN. <br><br> This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>RelistItem</b> request, and if at least one listing recommendation exists for the newly relisted item. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item based on eBay's listing recommendation(s). RelistItem Conditionally Enables a seller to change the properties of a currently active fixed-price listing (including multi-variation listings). AddFixedPriceItem, RelistFixedPriceItem, ReviseItem UseTopicAlias RevisingItems Pictures UseTopicAlias ConsideringBestMatch UseTopicAlias BestMatchReviseRelist UseTopicAlias Child elements hold the values for item details that you want to change. The Item.ItemID must always be set to the ID of the listing being changed. Only specify Item fields for the details that are changing. Unless otherwise specified in the field descriptions below, the listing retains its existing values for fields that you don't pass in the ReviseFixedPriceItem request. Use DeletedField to remove a field from the listing. ReviseFixedPriceItem Yes Specifies the name of a field to delete from a listing. The request can contain zero, one, or many instances of DeletedField (one for each field to be deleted). See the relevant field descriptions to determine when to use DeletedField (and potential consequences). <br><br> You cannot delete required fields from a listing. <br><br> Some fields are optional when you first list an item (e.g., SecondaryCategory), but once they are set they cannot be deleted when you revise an item. Some optional fields cannot be deleted if the item has bids and/or ends within 12 hours. Some optional fields cannot be deleted if other fields depend on them. See the eBay Trading API guide for rules on removing values when revising items. <br><br> Some data (such as Variation nodes within Variations) can't be deleted by using DeletedFields. See the relevant field descriptions for how to delete such data. <br><br> DeletedField accepts the following path names, which delete the corresponding nodes: <br><br> Item.ApplicationData<br> Item.AttributeSetArray<br> Item.ConditionID<br> Item.ItemSpecifics<br> Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br> Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br> Item.ListingDesigner.LayoutID<br> Item.ListingDesigner.ThemeID<br> Item.ListingEnhancement[Value]<br> Item.PayPalEmailAddress<br> Item.PictureDetails.GalleryURL<br> Item.PictureDetails.PictureURL<br> Item.PostalCode<br> Item.ProductListingDetails<br> Item.SellerContactDetails<br> Item.SellerContactDetails.CompanyName<br> Item.SellerContactDetails.County<br> Item.SellerContactDetails.InternationalStreet<br> Item.SellerContactDetails.Phone2AreaOrCityCode<br> Item.SellerContactDetails.Phone2CountryCode<br> Item.SellerContactDetails.Phone2CountryPrefix<br> Item.SellerContactDetails.Phone2LocalNumber<br> Item.SellerContactDetails.PhoneAreaOrCityCode<br> Item.SellerContactDetails.PhoneCountryCode<br> Item.SellerContactDetails.PhoneCountryPrefix<br> Item.SellerContactDetails.PhoneLocalNumber<br> Item.SellerContactDetails.Street<br> Item.SellerContactDetails.Street2<br> Item.ShippingDetails.PaymentInstructions<br> Item.SKU (unless InventoryTrackingMethod is SKU)<br> Item.SubTitle <br><br> These values are case-sensitive. Use values that match the case of the schema element names (Item.PictureDetails.GalleryURL) or make the initial letter of each field name lowercase (item.pictureDetails.galleryURL). However, do not change the case of letters in the middle of a field name. For example, item.picturedetails.galleryUrl is not allowed. <br><br> To delete a listing enhancement like BoldTitle, specify the value you are deleting in square brackets ("[ ]"); for example, Item.ListingEnhancement[BoldTitle]. ReviseFixedPriceItem Conditionally Returns the Item ID, SKU (if any), listing recommendations (if applicable), the estimated fees for the revised listing (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details. Item ID that uniquely identifies the item listing that was revised. Provided for confirmation purposes. The value returned should be the same as the item ID specified in the ItemID property of the Item object specified as input for the call. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) ReviseFixedPriceItem Always Item-level SKU for the listing, if the seller specified Item.SKU for the listing. Variation SKUs are not returned (see GetItem instead). ReviseFixedPriceItem Conditionally Starting date and time for the listing. ReviseFixedPriceItem Always Date and time when the new listing ends. This equals the starting time plus the listing duration. ReviseFixedPriceItem Always Child elements contain the estimated listing fees for the revised item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. Revising an item does not itself incur a fee. However, certain item properties are fee-based and result in the return of fees in the call's response. ReviseFixedPriceItem Always eBay.com Fees http://pages.ebay.com/help/sell/fees.html FeesPerSite UseTopicAlias FinalValueFeesAndCredits UseTopicAlias Final Value Fees http://pages.ebay.com/help/sell/fvf.html ID of the primary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. 10 ReviseFixedPriceItem Conditionally ID of the secondary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. 10 ReviseFixedPriceItem Conditionally The nature of the discount, if a discount applied. ReviseFixedPriceItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. ReviseFixedPriceItem Conditionally Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in reqards to Top-Rated Plus listing requirements, Item Specifics, picture requirements, and/or a recommendation to use a product code to list the item, such as a UPC, an EAN, or an ISBN. <br><br> This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>ReviseFixedPriceItem</b> request, and if at least one listing recommendation exists for the listing about to be revised. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item again based on eBay's listing recommendation(s). ReviseFixedPriceItem Conditionally Enables a seller to change the price and quantity of a currently- active, fixed-price listing. Using ReviseInventoryStatus to modify data qualifies as revising the listing. <br> <br> Inputs are the item IDs or SKUs of the listings being revised, and the price and quantity that are being changed for each revision. Only applicable to fixed-price listings.<br> <br> Changing the price or quantity of a currently- active, fixed-price listing does not reset the Best Match performance score. For Best Match information related to multi-variation listings, see the Best Match information at the following topic: <a href="http://pages.ebay.com/sell/variation/">Multi-quantity Fixed Price listings with variations</a>.<br> <br> As with all listing calls, the site you specify in the request URL (for SOAP) or the X-EBAY-API-SITEID HTTP header (for XML) should match the original listing's <b>Item.Site</b> value. In particular, this is a best practice when you submit new and revised listings.<br> <br> <b>For Large Merchant Services users:</b> When you use ReviseInventoryStatus within a Merchant Data file, it must be enclosed within two BulkDataExchangeRequest tags. After release 637, a namespace is returned in the BulkDataExchangeResponseType (top level) of the response. The BulkDataExchange tags are not shown in the call input/output descriptions. Enables a seller to change the price and quantity of currently active fixed-price items. AddItems, GetSellerList, ReviseItem, RelistItem TargetSite UseTopicAlias ConsideringBestMatch UseTopicAlias BestMatchReviseRelist UseTopicAlias Contains the updated quantity and/or price of a listing being revised. You should not modify the same listing twice (by using a duplicate ItemID or SKU) in the same request; otherwise, you may get an error or unexpected results. (For example, you should not use one InventoryStatus node to update the quantity and another InventoryStatus node to update the price of the same item.) You can pass up to 4 InventoryStatus nodes in a single request. ReviseInventoryStatus Yes 4 Returns the Item ID or SKU with changed Price and Quantity for the revised listing. Confirms the quantity and price associated with a listing or variation that was revised. StartTime, EndTime ReviseInventoryStatus Always 4 Child elements contain the estimated listing fees for a listing that was revised. Use the ItemID to correlate the Fees data with the InventoryStatus data in the response. The fees do not include the Final Value Fee (FVF), which can't be determined until the listing has sales.<br> <br> If you revise a variation in a multi-variation listing, the fees are for the entire listing. The insertion fee and listing fee are affected by the highest priced variation in the listing (which is not necessarily the variation that you passed in the request).<br> <br> Also note that the call returns only one Fees node per listing. For example, if you revise 4 variations from the same multi-variation listing, the response includes 4 InventoryStatus nodes and 1 Fees node. ReviseInventoryStatus Always eBay.com Fees http://pages.ebay.com/help/sell/fees.html FeesPerSite UseTopicAlias FinalValueFeesAndCredits UseTopicAlias Final Value Fees http://pages.ebay.com/help/sell/fvf.html Enables a seller to change the properties of a currently active listing.&nbsp;<b>Also for Half.com</b>. <br> <br> After one item in a multi-quantity fixed-price listing has been sold, you can not the values in the Title, Primary Category, Secondary Category, Listing Duration, and Listing Type fields for that listing. However, all other fields in the multi-quantity, fixed-price listing are editable. <br> <br> Inputs are the Item ID of the listing you are revising, and the field or fields that you are updating. AddItem, AddToItemDescription, GetItem, GetSellerList, RelistItem, ReviseFixedPriceItem, GetCategories, GetCategoryMappings UseTopicAlias RevisingItems Pictures UseTopicAlias ConsideringBestMatch UseTopicAlias BestMatchReviseRelist UseTopicAlias Child elements hold the values for properties that are changing. The Item.ItemID property must always be set to the ID of the item listing being changed. Set values in the Item object only for those properties that are changing. Use DeletedField to remove a property. <br><br> Applicable to Half.com. ReviseItem Yes Specifies the name of a field to delete from a listing. See the eBay Trading API guide for rules on deleting values when revising items. Also see the relevant field descriptions to determine when to use DeletedField (and potential consequences). The request can contain zero, one, or many instances of DeletedField (one for each field to be deleted). <br><br> You cannot delete required fields from a listing. <br><br> Some fields are optional when you first list an item (e.g., SecondaryCategory), but once they are set they cannot be deleted when you revise an item. Some optional fields cannot be deleted from auction listings if the item has bids and/or ends within 12 hours. Some optional fields cannot be deleted if other fields depend on them. <br><br> Some data (such as Variation nodes within Variations) can't be deleted by using DeletedFields. See the relevant field descriptions for how to delete such data. See the eBay Web Services guide for rules on removing values when revising items. Also see the relevant field descriptions for details on when to use DeletedField (and potential consequences). <br><br> DeletedField accepts the following path names, which delete the corresponding nodes: <br><br> Item.ApplicationData<br> Item.AttributeSetArray<br> Item.BuyItNowPrice<br> Item.ConditionID<br> Item.ExtendedSellerContactDetails<br> Item.ClassifiedAdContactByEmailEnabled<br> Item.ItemSpecifics<br> Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br> Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br> Item.ListingDesigner.LayoutID<br> Item.ListingDesigner.ThemeID<br> Item.ListingDetails.MinimumBestOfferMessage<br> Item.ListingDetails.MinimumBestOfferPrice<br> Item.ListingEnhancement[Value]<br> Item.PayPalEmailAddress<br> Item.PictureDetails.GalleryURL<br> Item.PictureDetails.PictureURL<br> Item.PostalCode<br> Item.ProductListingDetails<br> Item.SellerContactDetails<br> Item.SellerContactDetails.CompanyName<br> Item.SellerContactDetails.County<br> Item.SellerContactDetails.InternationalStreet<br> Item.SellerContactDetails.Phone2AreaOrCityCode<br> Item.SellerContactDetails.Phone2CountryCode<br> Item.SellerContactDetails.Phone2CountryPrefix<br> Item.SellerContactDetails.Phone2LocalNumber<br> Item.SellerContactDetails.PhoneAreaOrCityCode<br> Item.SellerContactDetails.PhoneCountryCode<br> Item.SellerContactDetails.PhoneCountryPrefix<br> Item.SellerContactDetails.PhoneLocalNumber<br> Item.SellerContactDetails.Street<br> Item.SellerContactDetails.Street2<br> Item.ShippingDetails.PaymentInstructions<br> Item.SKU (unless InventoryTrackingMethod is SKU)<br> Item.SubTitle <br><br> These values are case-sensitive. Use values that match the case of the schema element names (Item.PictureDetails.GalleryURL) or make the initial letter of each field name lowercase (item.pictureDetails.galleryURL). However, do not change the case of letters in the middle of a field name. For example, item.picturedetails.galleryUrl is not allowed. <br><br> To delete a listing enhancement like BoldTitle, specify the value you are deleting in square brackets ("[ ]"); for example, Item.ListingEnhancement[BoldTitle]. ReviseItem Conditionally When the VerifyOnly boolean tag value is supplied as 'true', the response will include the calculated listing price change if there is an increase in the BIN/Start price, but does not persist the values in DB. This call is similar to VerifyAddItem in revise mode. ReviseItem Conditionally Returns the Item ID, SKU (if any), listing recommendations (if applicable), the estimated fees for the revised listing (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details. Item ID that uniquely identifies the item listing that was revised. Provided for confirmation purposes. The value returned should be the same as the item ID specified in the ItemID property of the Item object specified as input for the call. Also applicable to Half.com. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) ReviseItem Always Starting date and time for the revised listing. Also returned for Half.com (for Half.com, the start time is always the time the item was originally listed). ReviseItem Always Date and time when the new listing ends. This is the starting time plus the listing duration. Also returned for Half.com, but for Half.com the actual end time is GTC (not the end time returned in the response). ReviseItem Always Child elements contain the estimated listing fees for the revised item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. Revising an item does not itself incur a fee. However, certain item properties are fee-based and result in the return of fees in the call's response. Not applicable to Half.com. ReviseItem Always ID of the primary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. Not applicable to Half.com. 10 ReviseItem Conditionally ID of the secondary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. Not applicable to Half.com. 10 ReviseItem Conditionally Supporting VerifyOnly for ReviseItem call as part of project 24083 (API - Critical enhancements). When the VerifyOnly boolean tag value is supplied as 'true', the response will include the calculated listing price change if there is an increase in the BIN/Start price, but does not persist the values in DB. This call is simialr to VerifyAddItem in revise mode. ReviseItem Conditionally The nature of the discount, if a discount applied. ReviseItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. ReviseItem Conditionally Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in reqards to Top-Rated Plus listing requirements, Item Specifics, picture requirements, and/or a recommendation to use a product code to list the item, such as a UPC, an EAN, or an ISBN. <br><br> This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>ReviseItem</b> request, and if at least one listing recommendation exists for the listing about to be revised. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item again based on eBay's listing recommendation(s). ReviseItem Conditionally Specifies the shipment tracking information associated with one package of an order. If multiple packages are required for the order, this call must be made separately for each package. <br/><br/> <span class="tablenote"> <strong>Note:</strong> For orders on the eBay India site, SetShipmentTrackingInfo cannot be used if the buyer uses PaisaPay as the payment method. </span> <span class="tablenote"> <strong>Note:</strong> SetShipmentTrackingInfo cannot be issued on its own like an ordinary API call, using an endpoint. This Large Merchant Services call must be entered one or more times as the payload in a data file that will be uploaded to an eBay server using the File Transfer API, then processed using the Bulk Data Exchange API. This call will fail if you attempt to invoke it directly. <br/><br/> In the Trading API, the CompleteSale call provides similar functionality that you can invoke directly. For more information, see the <a href="http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/CompleteSale.html" target="_blank">CompletSale call reference</a>. </span> Specifies the shipment tracking information associated with one package of an order. A unique identifier that identifies a single line item or multiple line item (Combined Payment) order. <br><br> For a single line item order, the OrderID value is identical to the OrderLineItemID value that is generated upon creation of the order line item. For a Combined Payment order, the OrderID value is created by eBay when the buyer or seller (sharing multiple, common order line items) combines multiple order line items into a Combined Payment order through the eBay site. A Combined Payment order can also be created by the seller through the AddOrder call. Either the OrderID or the OrderLineItemID value must be passed in the request. SetShipmentTrackingInfo Conditionally A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. Either the OrderLineItemID or the OrderID value must be passed in the request. SetShipmentTrackingInfo Conditionally Container consisting of the shipping carrier name, the package tracking number, and optionally, the timestamp of the shipment. SetShipmentTrackingInfo No When shipment tracking information is provided through the Shipment container in the same request, the <b>IsShipped</b> status is set to true automatically. If the call is successful, the specified order or order line item(s) are marked as Shipped in My eBay. <br><br> If the seller includes and sets this field to false, the order or order line item(s) are marked (or remain) as Not Shipped in My eBay. true SetShipmentTrackingInfo No The seller includes and sets this field to true if the buyer has paid for the order. If the call is successful, the order line item(s) are marked as Paid in My eBay. <br><br> If the seller includes and sets this field to false, the order line item(s) are marked (or remain) as Not Paid in My eBay. <br><br> If this field is not included, the paid status of the order line item(s) remain unchanged in My eBay. SetShipmentTrackingInfo No Response to a SetShipmentTrackingInfo request that verifies whether or not the call request reached the eBay servers with or without errors. OrderLineItemID is required upon input and always returned in the response. You can use this field to track whether or not a response is returned for every request, and to match specific responses to Specific requests. SetShipmentTrackingInfo Always Lists all items that have been sold by this seller. If a buyer purchased multiple items from a single listing, the sale will result in a single Order ID for the total purchase with a separate Line Item ID for each of the purchased items. The SoldReport request returns the data for all of your new orders (newly-sold items) with Order ID and Order Line Item ID. The Sold Report includes all transactions for the past 30 days (from the transaction creation date). <br/><br/> <span class="tablenote"> <strong>Note:</strong> SoldReport cannot be issued on its own like an ordinary API call, using an endpoint. This Large Merchant Services call must be invoked as a parameter in a Bulk Data Exchange API call, which will produce a report that can be downloaded using a File Transfer API call. This call has no request type. </span> <br><br> The concept of an 'Order' is only used in the Trading API when a buyer makes combined payments. Each payment is a transaction. But in the Large Merchant Services solution, every sale is considered to be an Order. It is important to recognize these conceptual differences when you are working with multiple APIs. <br><br> OrderLineItemID is a based upon the combination of the eBay Trading API's ItemID and TransactionID fields. The number before the hyphen is the Item ID and the number after the hyphen is the Transaction ID. The Transaction field in the Trading API is a container that can include many types of transaction information. <br><br> See <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#Response.TransactionArray.Transaction.TransactionID" target="_blank">Trading API</a> for more information. <br><br> Sellers use the information in the SoldReport to make inventory updates and start order fulfillment. <br><br> <span class="tablenote"> <b>Note:</b> After release 637, a namespace is returned in the BulkDataExchangeResponseType (top level) of the response. This container is not shown in the call output description, but you can see it in the call samples at the end of this page. See <a href="http://developer.ebay.com/DevZone/large-merchant-services/Concepts/MakingACall.html" target="_blank">Making An API Call</a> for more information about the BulkDataExchange Response container. </span> Contains information about the sold item, such as: order ID, buyer information, shipping information, order creation time, payment cleared time, tax amount, insurance cost, and total cost. Lists all items that have been sold by this seller. If a buyer purchased multiple items from a single listing, the sale will result in a single Order ID for the total purchase with a separate Line Item ID for each of the purchased items. The SoldReport request returns the data for all of your new orders (newly-sold items) with Order ID and Order Line Item ID. The Sold Report includes all transactions for the past 30 days (from the transaction creation date). <br><br> The concept of an 'Order' is only used in the Trading API when a buyer makes combined payments. Each payment is a transaction. But in the Large Merchant Services solution, every sale is considered to be an Order. It is important to recognize these conceptual differences when you are working with multiple APIs. <br><br> OrderLineItemID is a based upon the combination of the eBay Trading API's ItemID and TransactionID fields. The number before the hyphen is the Item ID and the number after the hyphen is the Transaction ID. The Transaction field in the Trading API is a container that can include many types of transaction information. <br><br> See <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#Response.TransactionArray.Transaction.TransactionID" target="_blank">Trading API</a> for more information. <br><br> The Sold Report includes all transactions for the past 30 days (from the transaction creation date), but does not include items where the sale of the item has been acknowledged using the OrderAckRequest. See <a href="http://developer.ebay.com/DevZone/large-merchant-services/Concepts/LMS_APIGuide.html#soldrpt" target="_blank">Acknowledging Sales</a> for more information. <br><br> Sellers use the information in the SoldReport to make inventory updates and start order fulfillment. <br><br> Note: After release 637, a namespace is returned in the BulkDataExchangeResponseType (top level) of the response. This container is not shown in the call output description, but you can see it in the call samples at the end of this page. See <a href="http://developer.ebay.com/DevZone/large-merchant-services/Concepts/MakingACall.html" target="_blank">Making An API Call</a> for more information about the BulkDataExchange Response container. Contains information about the sold item, such as: order ID, order line item ID, buyer information, shipping information, order creataion time, payment cleared time, tax amount, insurance cost, and total cost. <br><br> See OrderLineItemType for more information about the OrderLineItemID field. SoldReport Always Uploads a picture for a listing and returns a URL for the picture. UseTopicAlias Pictures UseTopicAlias PictureDetails UseTopicAlias Gallery UseTopicAlias VariationPictures A name you provide for the picture. Returned as SiteHostedPictureDetails.PictureName in the call response. UploadSiteHostedPictures No Specifies the picture system version. Only version 2 is valid. Available to support future changes in the picture system version. 2 UploadSiteHostedPictures No The image sizes that will be generated. Standard Large UploadSiteHostedPictures No An optional reference ID to the binary attachment. The PictureData field does not contain the binary attachment. The binary attachment is image data, including headers, from a JPG, GIF, PNG, BMP, or TIF format image file. The binary attachment must be sent as a MIME attachment, in your POST request, after the XML input. <br> <br> <b>Note: Not applicable for eBay Large Merchant Services. Use the ExternalPictureURL field instead.</b> UploadSiteHostedPictures No When the My Picture Uploads feature is available (see the Trading API Release Notes), applications (including non-listing apps, such as photo-editors and digital-camera software) will be able to use the PictureUploadPolicy field to specify that an uploaded picture is available to a seller on the eBay site. When you use PictureUploadPolicy, you are specifying that the picture you uploaded (and its URL) is stored for 48 hours on the eBay site. (If, within 48 hours, the picture is associated with an item, then it persists on the eBay site for the same time length as other pictures uploaded using the UploadSiteHostedPictures call). As a result of the storage on the eBay site, the picture is available to the seller on the My Picture Uploads tab within the Sell Your Item (SYI) pages. A maximum of 25 URLs can be stored. UploadSiteHostedPictures No Include the URL for a picture that you want to include in your listing. You can only include one ExternalPictureURL field per call. <br><br> <span class="tablenote"><b>Note:</b> If a URI contains spaces, replace them with <code>%20</code>. For example, <code>http://example.com/my image.jpg</code> must be submitted as <code>http://example.com/my%20image.jpg</code> to replace the space in the image file name. </span> <br> <br> This field allows the eBay server to retrieve a picture from a URL on an external web server. Once retrieved, the picture will be copied to eBay Picture Services (EPS), and retained for 90 days, plus the length of your listing duration. <br> <br> <b>Note: The ExternalPictureURL field is required when using eBay Large Merchant Services.</b> 1024 1 UploadSiteHostedPictures Conditionally 1 This is the type of watermark that should be applied to the pictures hosted by the eBay Picture Services. Please note that watermarks are applied only to pictures that are greater than an EPS configured size. The possible values are: None, Both, Icon, or SellerId. UploadSiteHostedPictures No The number of days to extend the expiration date for the specified image, after a listing has ended. This call is restricted to applications that have been granted permission to use it by eBay Developer Technical Support. <br><br> This call is not needed for active listings - it is meant to be used only when a photo needs to be hosted longer than the normal listing duration. <br><br> The maximum number of days allowed for this field is 30. 1 30 UploadSiteHostedPictures No Contains information about a picture upload (i.e., information about a picture upload containing a binary attachment of an image). Specifies the picture system version that was used to upload pictures. Only version 2 is valid. UploadSiteHostedPictures Always Contains information about an UploadSiteHostedPictures upload, including the URL of the uploaded picture. UploadSiteHostedPictures Always Enables a seller to test the definition of a new fixed-price listing by submitting the definition to eBay without creating a actual listing. AddFixedPriceItem, VerifyAddItem UseTopicAlias ListingAnItem Pictures UseTopicAlias Root container holding all values that define a new fixed-price listing. VerifyAddFixedPriceItem Yes Returns the listing recommendations (if applicable), the estimated fees for the proposed new listing (except the Final Value Fee, which isn't calculated until the item has sold), and other details. Represents the item ID for the new fixed-price listing. VerifyAddFixedPriceItem does not actually list an item, so 0 is returned instead of a normal item ID. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) VerifyAddFixedPriceItem Always Item-level SKU for the new listing, if the seller specified tem.SKU in the request. Variation SKUs are not returned (see GetItem instead). AddFixedPriceItem Conditionally Child elements contain the estimated listing fees for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. VerifyAddFixedPriceItem Always Indicates whether the item would be listed on eBay Express. See ExpressItemRequirements for hints about why this value is true or false for a given item. Contains details about why an item does or doesn't qualify as an eBay Express listing. Only returned when IncludeExpressRequirements is true the request.<br> <br> The item requirements are assessed in this order:<br> - SellerExpressEligible<br> - ExpressOptOut<br> - ExpressApproved<br> - All other settings ID of the primary category in which the item would be listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. 10 VerifyAddFixedPriceItem Conditionally ID of the secondary category in which the item would be listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. 10 VerifyAddFixedPriceItem Conditionally The nature of the discount, if a discount would have applied had this actually been listed at this time. VerifyAddFixedPriceItem Conditionally Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in reqards to Top-Rated Plus listing requirements, Item Specifics, picture requirements, and/or a recommendation to use a product code to list the item, such as a UPC, an EAN, or an ISBN. <br><br> This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>VerifyAddFixedPriceItem</b> request, and if at least one listing recommendation exists for the listing about to be listed. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the listing based on eBay's listing recommendation(s) before actually creating the listing through an <b>AddFixedPriceItem</b> call. VerifyAddFixedPriceItem Conditionally Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing.&nbsp;<b>Also for Half.com</b>. <br><br> Sellers who engage in cross-border trade on sites that require a recoupment agreement, must agree to the recoupment terms before adding or verifying items. This agreement allows eBay to reimburse a buyer during a dispute and then recoup the cost from the seller. The US site is a recoupment site, and the agreement is located <a href="https://scgi.ebay.com/ws/eBayISAPI.dll?CBTRecoupAgreement">here</a>. The list of the sites where a user has agreed to the recoupment terms is returned by the GetUser response. AddItem, VerifyAddFixedPriceItem UseTopicAlias ListingAnItem UseTopicAlias Pictures Root container holding all values that define a new listing. VerifyAddItem Yes Indicates if the response should include detailed data relating to whether an item would qualify as an Express listing. For information about the Express-related data that can be returned when IncludeExpressRequirements is set to true, see the response of VerifyAddItem and see the eBay Web Services Guide. <b>Deprecated.</b> This field will be removed from the schema in a future release. Recommended usage as of release 439 varies for eBay.com listings and Half.com listings. <br><br> For eBay.com listings: As of release 439, this field can still be passed in, but we recommend that you update your applications to use the ExternalProductID field defined on the item instead (i.e., Item.ExternalProductID). If you specify both Item.ExternalProductID and this field in the same request, eBay uses the value in Item.ExternalProductID and ignores the value in this field. See Item.ExternalProductID for information on using an external ID for eBay.com listings. <br><br> For Half.com listings: As of release 439, this field is required for Half.com listings. Causes Half.com to list the item with Pre-filled Item Information based on an ISBN value or other supported external ID, plus other meta-data that you specify. See the eBay Web Services guide for information about listing to Half.com. Returns the listing recommendations (if applicable), the estimated fees for the proposed new listing (except the Final Value Fee, which isn't calculated until the item has sold), and other details. Represents the item ID for the new listing. VerifyAddItem does not actually list an item, so 0 is returned instead of a normal item ID. <br><br> <span class="tablenote"><b>Note:</b> Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see <a href= "http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=468"> Common FAQs on eBay Item IDs and other eBay IDs</a> in the Knowledge Base. </span> 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) VerifyAddItem Always Child Fee containers provide the listing feature names, fees, and possible discounts for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. <br /> <br /> There is no guarantee that a PromotionalDiscount returned with VerifyAddItem will be realized when the seller uses AddItem to list the same item. This is the result of the timing of certain promotions. VerifyAddItem Always Indicates whether the item would be listed on eBay Express. See ExpressItemRequirements for hints about why this value is true or false for a given item. Contains details about why an item does or doesn't qualify as an eBay Express listing. Only returned when IncludeExpressRequirements is true the request. <br> <br> The item requirements are assessed in this order:<br> - SellerExpressEligible<br> - ExpressOptOut<br> - ExpressApproved<br> - All other settings ID of the primary category in which the item would be listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. 10 VerifyAddItem Conditionally ID of the secondary category in which the item would be listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. 10 VerifyAddItem Conditionally The nature of the discount, if a discount would have applied had this actually been listed at this time. VerifyAddItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. VerifyAddItem Conditionally Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in reqards to Top-Rated Plus listing requirements, Item Specifics, picture requirements, and/or a recommendation to use a product code to list the item, such as a UPC, an EAN, or an ISBN. <br><br> This container is only returned if the <b>IncludeRecommendations</b> flag was included and set to 'true' in the <b>VerifyAddItem</b> request, and if at least one listing recommendation exists for the listing about to be listed. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the listing based on eBay's listing recommendation(s) before actually creating the listing through an <b>AddItem</b> call. VerifyAddItem Conditionally Base type definition of the request payload, which can carry any type of payload content plus optional versioning information and detail level requirements. All concrete request types (e.g., AddItemRequestType) are derived from the abstract request type. The naming convention we use for the concrete type names is the name of the service (the verb or call name) followed by "RequestType": VerbNameRequestType Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request.<br> <br> The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.)<br> <br>Note that DetailLevel is required input for GetMyMessages. <br> <br> With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Yes GetMyMessages ReturnSummary, ReturnHeaders, ReturnMessages Yes GetAdFormatLeads GetBestOffers GetCategories GetCategory2CS GetCategoryMappings GetFeedback GetOrders GetSellerEvents GetTaxTable ReturnAll, none No GetCategoryFeatures GetMyeBayBuying GetMyeBaySelling GetUser GetUserDisputes ReturnAll, ReturnSummary, none No GetItemTransactions GetSellerList GetSellerTransactions GetOrderTransactions ItemReturnDescription, ReturnAll, none No GetSellingManagerTemplates GetItem ItemReturnAttributes, ItemReturnDescription, ReturnAll, none No Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). <br> ID--- country<br> ----- -----<br> de_AT Austria<br> de_CH Switzerland<br> de_DE Germany <br> en_AU Australia <br> en_CA Canada <br> en_GB United Kingdom<br> en_SG Singapore<br> en_US United States <br> es_ES Spain <br> fr_BE Belgium (French)<br> fr_CA Canada (French) <br> fr_FR France <br> it_IT Italy <br> nl_BE Belgium (Dutch)<br> nl_NL Netherlands <br> zh_CN China<br> en_IN India<br> en_IE Ireland<br> zh_HK Hong Kong No http://www.ietf.org/rfc/rfc3066.txt Tags for the Identification of Languages Most Trading API calls support a <b>MessageID</b> element in the request and a <b>CorrelationID</b> element in the response. If you pass in a <b>MessageID</b> in a request, the same value will be returned in the <b>CorrelationID</b> field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a <b>MessageID</b> value in the request, <b>CorrelationID</b> is not returned.<br> <br> <span class="tablenote"><b>Note:</b> <b>GetCategories</b> is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the <b>MessageID</b> and <b>CorrelationID</b> fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, <b>MessageID</b> and <b>CorrelationID</b> are applicable. </span> No The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects:<br> - It indicates the version of the code lists and other data that eBay should use to process your request.<br> - It indicates the schema version you are using.<br> You need to use a version that is greater than or equal to the lowest supported version.<br> <br> <b>For the SOAP API:</b> If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.<br> <br> <b>For the XML API:</b> If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) Conditionally HTTPHeaders UseTopicAlias eBay Schema Versioning Strategy ../../HowTo/eBayWS/eBaySchemaVersioning.html Lowest Supported Version ../../HowTo/eBayWS/eBaySchemaVersioning.html#VersionSupportSchedule The public IP address of the machine from which the request is sent. Your application captures that IP address and includes it in a call request. eBay evaluates requests for safety (also see the BotBlock container in the request and response of this call). PlaceOffer Yes Authentication information for the user on whose behalf the application is making the request. Only registered eBay users are allowed to make API calls. To verify that a user is registered, your application needs to pass a user-specific value called an "authentication token" in the request. This is equivalent to signing in on the eBay Web site. As API calls do not pass session information, you need to pass the user's authentication token every time you invoke a call on their behalf. All calls require an authentication token, except the calls you use to retrieve a token in the first place. (For such calls, you use the eBay member's username and password instead.) Yes UseTopicAlias GettingAToken Error tolerance level for the call. This is a preference that specifies how eBay should handle requests that contain invalid data or that could partially fail. This gives you some control over whether eBay returns warnings or blocking errors and how eBay processes the invalid data.<br> <br> This field is only applicable to AddItem and related calls, and only when the listing includes ProductListingDetails. AddItem AddItems AddLiveAuctionItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem BestEffort No ProductIDErrorHandling UseTopicAlias CompleteSale BestEffort, FailOnError FailOnError No A unique identifer for a particular call. If the same InvocationID is passed in after it has been passed in once on a call that succeeded for a particular application and user, then an error will be returned. The identifier can only contain digits from 0-9 and letters from A-F. The identifier must be 32 characters long. For example, 1FB02B2-9D27-3acb-ABA2-9D539C374228. 32 AddOrder AddToItemDescription PlaceOffer ReviseCheckoutStatus ReviseItem No You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. GetAccount GetAdFormatLeads GetAllBidders GetBestOffers GetBidderList GetCategories GetCategoryFeatures GetCategoryListings GetCrossPromotions GetFeedback GetHighBidders GetItem GetItemsAwaitingFeedback GetItemShipping GetItemTransactions GetMemberMessages GetMyeBayBuying GetMyeBaySelling GetMyMessages GetNotificationPreferences GetOrders GetOrderTransactions GetProducts GetSearchResults GetSellerEvents GetSellerList GetSellerPayments GetSellerTransactions No UseTopicAlias ConfiguringOutputRetrieveData Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.<br> <br> An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.<br> <br> WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.<br> <br> We recommend that you only use this during development and debugging. Do not use this in requests in your production code. No https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=499 Warning Level Container for a token and for user input. PlaceOffer Conditionally Base type definition of a response payload that can carry any type of payload content with following optional elements:<br> - timestamp of response message<br> - application-level acknowledgement<br> - application-level (business-level) errors and warnings This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. <br> <br> <span class="tablenote"><b>Note:</b> <b>GetCategories</b> and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.</span> OrderAck, SetShipmentTrackingInfo, SoldReport Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. CompleteSale, GetPopularKeywords, SoldReport PartialFailure Always CompleteSale GetPopularKeywords Always Most Trading API calls support a <b>MessageID</b> element in the request and a <b>CorrelationID</b> element in the response. If you pass in a <b>MessageID</b> in a request, the same value will be returned in the <b>CorrelationID</b> field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a <b>MessageID</b> value in the request, <b>CorrelationID</b> is not returned.<br> <br> <span class="tablenote"><b>Note:</b> <b>GetCategories</b> is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the <b>MessageID</b> and <b>CorrelationID</b> fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, <b>MessageID</b> and <b>CorrelationID</b> are applicable. </span> OrderAck, SetShipmentTrackingInfo, SoldReport Conditionally A list of application-level errors (if any) that occurred when eBay processed the request. SoldReport Conditionally UseTopicAlias ErrorHandling Supplemental information from eBay, if applicable. May elaborate on errors (such as how a listing violates eBay policies) or provide useful hints that may help a seller increase sales. This data can accompany the call's normal data result set or a result set that contains only errors. <br> <br> Applications must recognize when the Message field is returned and provide a means to display the listing hints and error message explanations to the user. <br> <br> The string can return HTML, including TABLE, IMG, and HREF elements. In this case, an HTML-based application should be able to include the HTML as-is in the HTML page that displays the results. A non-HTML application would need to parse the HTML and convert the table elements and image references into UI elements particular to the programming language used. As usual for string data types, the HTML markup elements are escaped with character entity references (e.g.,&lt;table&gt;&lt;tr&gt;...). AddFixedPriceItem AddItem AddItems AddToItemDescription EndItem PlaceOffer RelistFixedPriceItem RelistItem RespondToWantItNowPost ReviseFixedPriceItem ReviseItem VerifyAddFixedPriceItem VerifyAddItem Conditionally UseTopicAlias Message The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response. OrderAck, SetShipmentTrackingInfo, SoldReport Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. OrderAck, SetShipmentTrackingInfo, SoldReport Always Event name of the notification. Only returned by Platform Notifications. Information that explains a failure due to a duplicate InvocationID being passed in. AddFixedPriceItem AddItem AddItems AddLiveAuctionItem AddOrder AddSecondChanceItem AddToItemDescription PlaceOffer RelistFixedPriceItem RelistItem ReviseCheckoutStatus ReviseFixedPriceItem ReviseItem Conditionally Recipient user ID of the notification. Only returned by Platform Notifications. Unique Identifier of Recipient user ID of the notification. Only returned by Platform Notifications (not for regular API call responses). A Base64-encoded MD5 hash that allows the recipient of a Platform Notification to verify this is a valid Platform Notification sent by eBay. Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. FetchToken, OrderAck, SetShipmentTrackingInfo, GetSessionID, SoldReport Conditionally Container of token, image URL and audio URL. PlaceOffer Conditionally An application subscribing to notifications can include an XML-compliant string, not to exceed 256 characters, which will be returned. The string can identify a particular user. Any sensitive information should be passed with due caution. <br><br> To subscribe to and receive eBay Buyer Protection notifications, this field is required, and you must pass in 'eBP notification' as a string. SetNotificationPreferences Conditionally GetNotificationPreferences Conditionally This code identifies the acknowledgement code types that eBay could use to communicate the status of processing a (request) message to an application. This code would be used as part of a response message that contains an application-level acknowledgement element. (out) Request processing succeeded (out) Request processing failed (out) Request processing completed with warning information being included in the response message (out) Request processing completed with some failures. See the Errors data to determine which portions of the request failed. (out) Reserved for internal or future use. Container of token and user reply. An encrypted token that eBay generates and that applications need to pass as input to subsquent calls. One use of this might be to block users from the site due to multiple call requests. PlaceOffer Conditionally The user's response to being asked to type the message in the botblock challenge image (that is, the image corresponding to BotBlockUrl that has been returned in a previous call). PlaceOffer Conditionally Container of token and image URL and Audio URL. An encrypted token generated by eBay when the botblock mechanism is triggered. This token is mapped to BotBlockUrl and BotBlockAudioUrl. PlaceOffer Conditionally The URL of the image that your application should display to the user for a botblock challenge. PlaceOffer Conditionally The URL of the audio-clip that your application should provide for sight-impaired users. The BotBlockAudioUrl audio-clip corresponds to the BotBlockUrl image. PlaceOffer Conditionally Identifies payment methods used by a buyer to pay a seller. On item listings, identifies one of the payment methods seller will accept for the item. Available payment methods can differ by site and item. Payment methods are not applicable to eBay Real Estate ad format listings. No payment method specified. For example, no payment methods would be specified for Ad format listings. Money order/cashiers check. Not applicable to US/CA eBay Motors listings. American Express. Not applicable to US/CA eBay Motors listings. Payment instructions are contained in the item's description. Credit card. Not applicable to Real Estate or US/CA eBay Motors listings. Personal check. Cash on delivery. This payment method is obsolete (ignored) for the US, US eBay Motors, UK, and Canada sites. See "Field Differences for eBay Sites" in the eBay Web Services Guide for a list of sites that accept COD as a payment method. Not applicable to Real Estate listings. When revising an item (on sites that still support COD), you can add or change its value. Visa/Mastercard. These qualify as safe payment methods. Not applicable to US/CA eBay Motors listings. PaisaPay (for India site only). This qualifies as a safe payment method and is required for all categories on the IN site. Other forms of payment. Some custom methods are accepted by seller as the payment method in the transaction. Not applicable to US/CA eBay Motors listings (see PaymentSeeDescription instead). PayPal is accepted as a payment method. This qualifies as a safe payment method. If true in listing requests, Item.PayPalEmailAddress must also be specified.<br> <br> If you don't pass PayPal in the listing request but the seller's eBay preferences are set to accept PayPal on all listings, eBay will add PayPal as a payment method for you in most cases, and we may return a warning. <br> <br> PayPal must be accepted when the seller requires immediate payment (Item.AutoPay) or offers other PayPal-based features, such as a finance offer (Item.FinanceOfferID). PayPal must be accepted for charity listings. PayPal must be accepted for event ticket listings when the venue is in New York state or Illinois, so that eBay can offer buyer protection (per state law). (For some applications, it may be simplest to use errors returned from VerifyAddItem to flag the PayPal requirement for New York and Illinois ticket listings.) PayPal must be accepted for US eBay Motors listings that require a deposit (and it will not be set automatically based on the seller's preferences). Conversely, if PayPal is specified for US eBay Motors listings, deposit attributes must be specified.<br> Discover card. Not applicable to US/CA eBay Motors listings. Payment on delivery. Not applicable to Real Estate or US/CA eBay Motors listings. Direct transfer of money. Not applicable to US/CA eBay Motors listings. If the seller has bank account information on file, and MoneyXferAcceptedInCheckout = true, then the bank account information will be displayed in Checkout. Applicable only to certain global eBay sites. See the "International Differences Overview" in the eBay Web Services Guide. All other online payments. Not applicable to US/CA eBay Motors listings. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for internal or future use. Loan check option (applicable only to the US eBay Motors site, except in the Parts and Accessories category, and the eBay Canada site for motors). Cash-in-person option. Applicable only to US and Canada eBay Motors vehicles, (not the Parts and Accessories category). Elektronisches Lastschriftverfahren (direct debit). Only applicable to the Express Germany site, which has been shut down. 579 NoOp PaisaPayEscrow payment option. Applicable on selected categories on the India site only. PaisaPayEscrowEMI (Equal Monthly Installments) Payment option. Must be specified with PaisaPayEscrow. Applicable only to India site. This payment method can be added only if a seller has a payment gateway account. You can use GetUser.User.SellerInfo.IntegratedMerchantCreditCardInfo to determine if a seller has a payment gateway account. If a seller successfully uses AddItem with IntegratedMerchantCreditCard, then for the resulting item, the IntegratedMerchantCreditCard value is a replacement for a credit-card payment method such as VisaMC. In such a case, the listing displays (to potential buyers) the credit cards that the seller specified in the seller's preferences for their payment gateway account (in My eBay). Additionally, a buyer's credit-card payment is integrated into eBay checkout. The Moneybookers payment method. For more information, see http://www.moneybookers.com/partners/us/ebay. Only applicable to the US site (and to the Parts and Accessories category of the US eBay Motors site). The Paymate payment method. For more information, see http://www.paymate.com/eBay. Only applicable to the US site (and to the Parts and Accessories category of the US eBay Motors site). The ProPay payment method. US site only. For more information, see http://www.Propay.com/eBay. PayOnPickup payment method. PayOnPickup is the same as CashOnPickup. For listings on the eBay US site, the user interface refers to this feature as Pay on pickup. In the user interface of your application, please refer to the feature as Pay on pickup so that the name in your user interface corresponds to the name on the eBay US site. This payment method can be added only if a seller has a IMCC payment gateway account and Diners Club card is selected in credit card preference. Currently Dines card is enabled for CyberSource Gateway sellers. Unless the buyer and seller agree to COD (Cash On Delivery) or POP (Pay on Pickup) as the form of payment for an order, StandardPayment is always the buyer payment method returned to the seller when the order is part of the new payment process on the German and Austrian sites. <br><br> <span class="tablenote"><b>Note:</b> The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. </span> <br> Security header used for SOAP API calls. Authentication token representing the user who is making the request. The user's token must be retrieved from eBay. To determine a user's authentication token, see the Authentication and Authorization information in the eBay Web Services guide. For calls that list or retrieve item or transaction data, the user usually needs to be the seller of the item in question or, in some cases, the buyer. Similarly, calls that retrieve user or account data may be restricted to the user whose data is being requested. The documentation for each call includes information about such restrictions. 2000 FetchToken Yes UseTopicAlias GettingAToken Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. GetSessionID,FetchToken Conditionally Authentication information for the user on whose behalf the application is making the request, and authorization information for the application making the request. Only registered eBay users are allowed to make API calls. To verify that a user is registered, your application normally needs to pass a user-specific value called an "authentication token" in the request. This is equivalent to signing in on the eBay Web site. As API calls do not pass session information, you need to pass the user's authentication token every time you invoke a call on their behalf. All calls require an authentication token, except the calls you use to retrieve a token in the first place. For such calls, you use the eBay member's username and password instead. FetchToken Yes A Base64-encoded MD5 hash that allows the recepient of a Platform Notification to verify this is a valid Platform Notification sent by eBay. Specifies standard subsets of data to return for each result within the set of results in the response payload. If no detail level is specified, a base set of data is returned. The base set of data varies per call. (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (in) Returns Description, plus the ListingDesigner node and some additional information if applicable (in) For GetItem, returns Item Specifics and Pre-filled Item Information, if any. For GetSearchResults, only returns Item Specifics (if any) that are applicable to search results, and only under certain conditions. See the description of Item.AttributeSetArray for details about the effects for applicable calls. Also see the description of Item.ProductListingDetails for GetItem. (in) For the GetSearchResults call, returns the primary category and, if applicable, the secondary category (in) Returns the summary data. For GetMyMessages, this detail level returns the same data whether or not you include MessageIDs or AlertIDs in the request. Returns up to 10 FolderID and FolderName values. Currently, this detail level is the only way to retrieve FolderID and FolderName values. See "GetMyMessages" in the eBay Web Services Guide for a code sample that demonstrates this. (in) Returns message headers. For GetMyMessages, if you include MessageIDs or AlertIDs in the request, this detail level returns header information, without body text, for the specified message ID or alert ID values. If you include a FolderID, header information is returned only for the messages and alerts in the specified folder. If you do not include MessageIDs or AlertIDs, this detail level returns header information for Alerts and Messages as follows: - If all the Alerts have been read, they are sorted in date order, with the most recent first. - If one of the Alerts has not been read, the Read Alerts come first, sorted most recent first, followed by the Unread Alert(s). - All messages in ascending order by date received with the oldest messages first. Note that even when restricted by this detail level to return only header information, GetMyMessages may return a high volume of data. (in) Returns full message information. For GetMyMessages, if you include MessageIDs or AlertIDs in the request, this detail level returns message information for the specified message ID or alert ID values. If you include a FolderID, message information is returned only for the messages and alerts in the specified folder. Contains properties that provide information on duplicate uses of InvocationIDs. The duplicate InvocationID. AddItem AddItems AddLiveAuctionItem AddOrder AddSecondChanceItem AddToItemDescription PlaceOffer RelistItem ReviseLiveAuctionItem ReviseCheckoutStatus ReviseItem Conditionally The status of the previous call that used the InvocationID. AddItem AddItems AddLiveAuctionItem AddOrder AddSecondChanceItem AddToItemDescription PlaceOffer RelistItem ReviseCheckoutStatus ReviseItem ReviseLiveAuctionItem Conditionally The id that identifies the business item the previous API invocation created. For example, the ItemID of the item created by an AddItem call. AddItem AddItems AddLiveAuctionItem AddOrder AddSecondChanceItem AddToItemDescription PlaceOffer RelistItem ReviseCheckoutStatus ReviseItem ReviseLiveAuctionItem Conditionally An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. (out) Reserved for internal or future use. Preferences that specify how eBay should handle certain requests that contain invalid data or that could partially fail. These preferences give you some control over whether eBay returns warnings or errors in response to invalid data and how eBay handles listing requests when such data is passed in. For example, these preferences are applicable to AddItem and related calls when Item Specifics are specified, and to CompleteSale. See the eBay Web Services Guide for details about these preferences and their effects. (in) Apply validation rules that were in effect prior to the time the call started supporting ErrorHandling. (in) Drop the invalid data, continue processing the request with the valid data. If dropping the invalid data leaves the request in a state where required data is missing, reject the request.<br> <br> If BestEffort is specified for CompleteSale, the Ack field in the response could return PartialFailure if one change fails but another succeeds. For example, if the seller attempts to leave feedback twice for the same order line item, the feedback changes would fail but any paid or shipped status changes would succeed. (in) If any attribute data is invalid, drop the entire attribute set and proceed with listing the item. If the category has required attributes and the attribute set is dropped, reject the listing. (in) If any data is invalid, reject the request. A variable that contains specific information about the context of this error. For example, if you pass in an attribute set ID that does not match the specified category, the attribute set ID might be returned as an error parameter. Use error parameters to flag fields that users need to correct. Also use error parameters to distinguish between errors when multiple errors are returned. The value of the variable (e.g., the attribute set ID) Conditionally The index of the parameter in the list of parameter types returned within the error type. Conditionally These are request errors (as opposed to system errors) that occur due to problems with business-level data (e.g., an invalid combination of arguments) that the application passed in. A brief description of the condition that raised the error. Conditionally A more detailed description of the condition that raised the error. Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document. other Conditionally Indicates whether the error message text is intended to be displayed to an end user or intended only to be parsed by the application. If true or not present (the default), the message text is intended for the end user. If false, the message text is intended for the application, and the application should translate the error into a more appropriate message. Only applicable to Item Specifics errors and warnings returned from listing requests. AddItem AddItems AddLiveAuctionItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. Conditionally API errors are divided between two classes: system errors and request errors. Conditionally Basic type for specifying measures and the system of measurement. A decimal value (e.g., 10.25) is meaningful as a measure when accompanied by a definition of the unit of measure (e.g., Pounds), in which case the value specifies the quantity of that unit. A MeasureType expresses both the value (a decimal) and, optionally, the unit and the system of measurement. Details such as shipping weights are specified as measure types. Unit of measure. This attribute is shared by various fields, representing units such as lbs, oz, kg, g, in, cm. <br><br> For weight, English major/minor units are pounds and ounces, and metric major/minor units are kilograms and grams. For length, the English unit is inches, and metric unit is centimeters. <br><br> To get the full list of package dimension and weight measurement units (and all alternative spellings and abbreviations) supported by your site, call <b>GeteBayDetails</b>. AddItem AddItems No GetItemShipping GetSellerTransactions GetShippingDiscountProfiles Conditionally GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GeteBayDetails GeteBayDetails.html The system of measurement (e.g., English). AddItem AddItems No GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetShippingDiscountProfiles Conditionally English system of measurement. Metric system of measurement. SeverityCodeType - Type declaration to be used by other schema. This code identifies the severity of an API error. A code indicates whether there is an API-level error or warning that needs to be communicated to the client. (out) Warning or informational error (out) Application-level error (out) Reserved for internal or future use Specifies a universally unique identifier for an item. This is used to ensure that you only list a particular item once, particularly if you are listing many items at once. The identifier can contain only digits from 0-9 and letters from A-F. The identifier must be 32 characters long. For example, 9CEBD9A6825644EC8D06C436D6CF494B. Item.Site in AddItem AddItem.html#Request.Item.UUID The application ID that is unique to each application you (or your company) has registered with the eBay Developers Program. If you are executing a call in the Sandbox, this is the "AppId" value that eBay issued to you when you received your Sandbox keys. If you are executing a call in Production, this is the "AppId" value that eBay issued to you when you received your Production keys. FetchToken Yes The unique developer ID that the eBay Developers Program issued to you (or your company). If you are executing a call in the Sandbox, this is the "DevId" value that eBay issued to you when you received your Sandbox keys. Typically, you receive your Sandbox keys when you register as a new developer. If you are executing a call in Production, this is the "DevId" value that eBay issued to you when you received your Production keys. Typically, you receive your Production keys when you certify an application. FetchToken Yes Authentication certificate that authenticates the application when making API calls. If you are executing a call in the Sandbox, this is the "CertId" value that eBay issued to you when you received your Sandbox keys. If you are executing a call in Production, this is the "CertId" value that eBay issued to you when you received your Production keys. This is unrelated to auth tokens. FetchToken Yes eBay user ID (i.e., eBay.com Web site login name) for the user the application is retrieving a token for. This is typically the application's end-user (not the developer). 64 FetchToken Yes Password for the user specified in Username. Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. Return warnings when the application passes unrecognized or deprecated elements in a request. eBay user ID (i.e., eBay.com Web site login name) for the user the application is retrieving a token for. This is typically the application's end-user (not the developer). 64 FetchToken Yes Password for the user specified in Username. Authentication token representing the user who is making the request. The user's token must be retrieved from eBay. To determine a user's authentication token, see the Authentication and Authorization information in the eBay Web Services guide. For calls that list or retrieve item or transaction data, the user usually needs to be the seller of the item in question or, in some cases, the buyer. Similarly, calls that retrieve user or account data may be restricted to the user whose data is being requested. The documentation for each call includes information about such restrictions. 2000 FetchToken Yes UseTopicAlias GettingAToken Cost of insuring the delivery of this order with the courier. Description of the fee type. FeeSettlementReport Conditionally List of transactions for a certain fee type. FeeSettlementReport Conditionally Indicates who owns the user's address. PayPal owns the address. eBay owns the address. Reserved for internal or future use. Codes indicate the address type. (out) Reserved for internal or future use AddressRegistrationTypeCodeType. For GetUserAddresss paypal migration (out) For GetUserAddress paypal migration. PayPal address status. (out) Reserved for internal or future use. Contains the data for an eBay user's address. This is the base type for a number of user addresses, including seller payment address, buyer shipping address and buyer and seller registration address. User's name for the address. Also applicable to Half.com (for GetOrders). This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetUserContactDetails Always GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetSellingManagerSoldListings Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally A concatenation of Street1 and Street2, primarily for RegistrationAddress. Not applicable to Half.com. GetBidderList Conditionally ShippingAddress GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally ShippingAddress GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No Line 1 of the user's street address. Also applicable to Half.com (for GetOrders). This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. GetBidderList Conditionally ShippingAddress ReviseSellingManagerSaleRecord No GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally ShippingAddress ShipToAddress GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates SellerContactDetails
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).<br> In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. GetBidderList Conditionally ShippingAddress GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally ShippingAddress ShipToAddress GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No The name of the user's city. Also applicable to Half.com (for GetOrders). This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. GetSellingManagerSaleRecord Always ShippingAddress GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally ReviseSellingManagerSaleRecord No GetBidderList Conditionally ShippingAddress GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally ShippingAddress ShipToAddress GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetUserContactDetails Always GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally County information for the user. This field applies to Classified Ad format listings and to the UK only. Not applicable to Half.com. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally The region of the user's address. Also applicable to Half.com (for GetOrders). This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally ReviseSellingManagerSaleRecord No GetBidderList Conditionally ShippingAddress GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally ShippingAddress ShipToAddress GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetUserContactDetails Always GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally The two-digit code representing the country of the user.<br> <br> If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.<br> <br> For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.<br> <br> Also applicable to Half.com (for GetOrders). GetAllBidders GetHighBidders GetUserContactDetails Always GetBidderList GetUserPreferences Conditionally GetItem GetSellingManagerTemplates RegistrationAddress ShippingAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
ShippingAddress ShipToAddress Conditionally GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetSellerList Conditionally HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
 ReviseSellingManagerSaleRecord No GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 SetUserPreferences No The name of the user's country. Also applicable to Half.com (for GetOrders). eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. GetBidderList Conditionally ShippingAddress GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
ShippingAddress ShipToAddress Conditionally GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number. <br/><br/> In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components. <br/><br/> Also applicable to Half.com (for GetOrders). eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
ShippingAddress ShipToAddress Conditionally GetBidderList ShippingAddress Conditionally GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetUserContactDetails Always GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally Standard ISO code for the country of the user's primay telephone phone number. For Classifed Ad format listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad format listings only. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally Country Prefix of the secondary phone number. This value is derived from inputs supplied for PhoneCountryCode. This field applies to Classified Ad format listings only. GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally Area or City Code of a user's primary phone number. This field applies to Classified Ad format listings only. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally The local number portion of the user's primary phone number. This field applies to Classified Ad format listings only. <br> <b>Note:</b> The full primary phone number is constructed by combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix. Starting with API release 497, the full phone number can be entered in PhoneLocalNumber. Refer to the release notes for additional information. 30 AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally Standard ISO code for the country of a user's secondary telephone phone number. For Classifed Ad format listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad format listings only. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally Country prefix of a user's secondary phone number. This value is derived from inputs supplied for Phone2CountryCode. This field applies to Classified Ad format listings only. GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally Area or City Code of a user's secondary phone number. This field applies to Classified Ad format listings only. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally The local number portion of the user's secondary phone number. This field applies to Classified Ad format listings only. <br> <b>Note:</b> The full secondary phone number is constructed by combining Phone2LocalNumber with Phone2AreaOrCityCode and Phone2CountryPrefix. Starting with API release 497, the full phone number can be entered in Phone2LocalNumber. Refer to the release notes for additional information. 30 AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally User's postal code.<br> <br> If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.<br> <br> For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.<br> <br> Also applicable to Half.com (for GetOrders). This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. GetBidderList Conditionally GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally GetSellerList HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally GetItem GetSellingManagerTemplates RegistrationAddress ShippingAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions ShippingAddress ShipToAddress
DetailLevel: none, ReturnAll
Conditionally GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetMyeBaySelling SoldList DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally GetAllBidders GetHighBidders Always GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetSellingManagerSoldListings Conditionally Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address. GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally The realm to which the address belongs (e.g. eBay vs PayPal). For GetOrders, applies only to Half.com. GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetOrders
DetailLevel: none, ReturnAll
Always GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally ShipToAddress PayPal address status. Not applicable to Half.com. ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders). 20 GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally Seller's international name that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com. GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetBidderList Conditionally ShippingAddress International state and city for the seller's payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com. GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetBidderList Conditionally ShippingAddress Seller's international street address that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com. GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetBidderList Conditionally ShippingAddress User's company name. Only returned if available. Not applicable to Half.com. GetUserContactDetails Always GetBidderList Conditionally ShippingAddress AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 Indicates the nature of the address (e.g., residential or business). Not applicable to Half.com. Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetAdFormatLeads Conditionally
DetailLevel: ReturnAll
 Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetAdFormatLeads Conditionally
DetailLevel: ReturnAll
 Secondary Phone number of the lead. Not returned if information is unavailable. GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally This tag tells whether current address is a default shipping address or one of the shipping addresses in address book. GetItemTransactions GetOrderTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider. <br/><br/> Example: "Reference #1234567890123456" GetItemTransactions GetOrderTransactions GetSellerTransactions GetOrders SellerShipmentToLogisticsProvider.ShipToAddress
DetailLevel: none, ReturnAll
Conditionally These values indicate type of an address in AddressType. This is default shipping address which is rendered to buyer on checkout. This is an address which is in user's address book. It can be used at the time of checkout. This is not a valid address. Please use another address. (out) Reserved for internal or future use. An eBay-defined complex type for specifying monetary amounts. <br><br> A double value (e.g., 1.00 or 1.0) is meaningful as a monetary amount when accompanied by a specification of the currency, in which case the value specifies the amount in that currency. An AmountType expresses both the value (a double) and the currency. <br><br> The AmountType data type is typically used to specify details such as prices, fees, costs, and payments. In some cases, a whole number (i.e., without a period) can be passed or returned as a monetary value. This is necessary to support certain currencies that are only expressed as whole numbers (like the Italian Lira and Spanish Peseta). <br><br> Because a double is used to represent the amount, this also means whole monetary amounts may be returned with only one 0 after the decimal. For example, a dollar value could be returned as 1.0 instead of 1.00 in calls like AddItem. For fields of type AmountType, see the individual topics for specific restrictions beyond this. Three-digit code representing the currency type being used. <br> <br> In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.<br> <br> In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. DeleteSellingManagerItemAutomationRule DeleteSellingManagerTemplateAutomationRule GetBidderList GetSellingManagerTemplateAutomationRule GetSellingManagerTemplates GetSellingManagerItemAutomationRule GetItemRecommendations GetItemShipping GetMyeBaySelling SetSellingManagerItemAutomationRule SetSellingManagerTemplateAutomationRule Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally AddOrder Order.Total Yes GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetMyeBayBuying
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles Conditionally RespondToBestOffer ReviseCheckoutStatus ReviseSellingManagerSaleRecord No InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected Always GetBestOffers
DetailLevel: none, ReturnAll
Always GetOrders InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected
DetailLevel: none, ReturnAll
Always GetOrders InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected
DetailLevel: none, ReturnAll
Conditionally GetSellerTransactions InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected
DetailLevel: none
Conditionally GetOrderTransactions InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally PlaceOffer ConvertedCurrentPrice CurrentPrice Always PlaceOffer MinimumToBid Conditionally AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem No Always AddLiveAuctionItem ReviseLiveAuctionItem No Always GetAllBidders GetStoreOptions Yes Always RelistItem No AddTransactionConfirmationItem Yes SendInvoice ShippingInsuranceCost, ShippingServiceCost, ShippingServiceAdditionalCost, SalesTaxAmount, InsuranceFee No GetSellingManagerSaleRecord AddItemFromSellingManagerTemplate Always This type defines the <b>AttributeArray</b> container, which is used by the seller to specify one or more attribute values for a Half.com item. This container is used by the seller to specify one or more attribute values for a Half.com item. This container can be used in <b>ReviseItem</b> to add, remove, or modify an attribute or its value. <br><br> This field is not applicable for eBay listings. AddItem AddItems VerifyAddItem Yes ReviseItem No GetOrders
DetailLevel: none, ReturnAll
Always No longer applicable to any eBay categories. Contains a list of attributes that describe category-specific aspects or features of an item in a standardized way.<br><br> For the AddItem family of calls and GetItem, an AttributeSetArray can contain a maximum of 2 full attribute sets (one for each category in which the item is listed) if the primary and secondary categories are mapped to different characteristic sets. If they are mapped to the same characteristic set, the AttributeSetArray can contain one full attribute set.<br> <br> An AttributeSetArray can also contain any number of additional site-wide attribute sets. In item-listing requests, AttributeSet is required if the category is mapped to a characteristic set with required attributes. On the US site, attributes are usually required for Tickets, eBay Motors vehicles, and Real Estate listings. See GetCategory2CS and GetAttributesCS. See the Developer's Guide for information about attribute meta-data and validation rules that are applicable when listing items.<br> <br> In GetItem, the Half.com item condition may be returned once in an AttributeSet node with Half.com IDs and values, and once in a separate AttributeSet node with a site-wide eBay item condition. The Half.com IDs are not necessarily returned in GetAttributesCS, so you can use the eBay.com data instead. Half.com listings may also return an AttributeSet node with other eBay attributes. 773 NoOp 889 Item.ItemSpecifics AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations RelistFixedPriceItem ReviseFixedPriceItem VerifyAddItem Conditionally RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No GetSellingManagerTemplates GetItemRecommendations Conditionally GetItem
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally No longer applicable to any eBay categories. 773 NoOp 889 Item.ItemSpecifics A salient aspect or feature of an item in a given category. Attributes are known as "Item Specifics" in the eBay Web site. Use attributes to describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard attribute for books. In item-listing requests, multiple attributes can be specified. Some categories (e.g., Tickets) always require certain attributes to be specified. Therefore, in item-listing requests you need to at least specify "editable" attributes (EditType 0 and EditType 2 attributes) if they are identified as required in the attribute meta-data. See the eBay Web Services guide for information about attribute meta-data, how to determine the valid attributes for a category, and how to determine whether attributes are required. <br><br> If you are revising or relisting an item, you don't need to pass in attributes that were already specified in the original listing. To remove an optional attribute, set all its value IDs to "-100". If the item has bids (or items have been sold) but there are more than 12 hours remaining until the listing ends, you can add Attribute nodes but you cannot remove or modify data in previously specified Attribute nodes. If the item has bids and the listing ends within 12 hours, you cannot add or remove Attribute nodes or modify the contents of previously specified Attribute nodes. <br><br> Not applicable to Half.com. 773 NoOp 889 Item.ItemSpecifics AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem Conditionally RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No GetItemRecommendations GetSellingManagerTemplates Conditionally GetItem
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally Constant value that identifies the attribute set in a language-independent way. Unique across all eBay sites. Corresponds to a characteristics set ID. Call GetCategory2CS to determine valid characteristics set IDs. Not applicable to Half.com. 773 NoOp 889 Item.ItemSpecifics AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem Conditionally GetSearchResults RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No GetCategoryListings GetItemRecommendations GetSellingManagerTemplates Conditionally GetSearchResults
DetailLevel: none, ItemReturnAttributes, ItemReturnCategories, ReturnAll
GranularityLevel: Coarse
Conditionally GetItem
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally Version of the attribute set being specified (in requests) or that is currently on the site. This value changes each time changes are made to the category-to-characteristic set mappings or characteristic set data. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed.<br><br> In listing requests, if you do not specify this value, eBay assumes you are using the current attribute set version. If you specify the version number of the attribute meta-data that you have stored locally, eBay will compare it to the current version on the site and return a warning if the versions do not match. If an error occurs due to invalid attribute data, this warning can be useful to help you determine if you might be sending outdated data. Not applicable to Half.com. 773 NoOp 889 Item.ItemSpecifics AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem Conditionally RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No GetItemRecommendations Conditionally GetItem
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally A salient aspect or feature of an item. On eBay.com, this information is used in the Item Specifics section of a listing to describe an item in a standard way so that buyers can find it more easily. A value the seller selected or entered for the attribute. At least one value is required for each Attribute that you specify. Some attributes can have multiple values. See the eBay Web Services guide sections on Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) for information about using GetAttributesCS to determine valid attribute values.<br><br> For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value. For Half.com, use AttributeArray.Attribute.Value. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, this does not use the same Attributes logic as eBay's Item Specifics. For Half.com, AttributeArray.Attribute.Value is required when you use AddItem. see the eBay Web Services Guide for valid values. You can revise AttributeArray.Attribute.Value for Half.com listings. AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem Conditionally RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No GetItemRecommendations Conditionally GetItem GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally GetOrders
DetailLevel: none, ReturnAll
Always Constant value that identifies the attribute in a language-independent way. Unique within the attribute set. See the Developer's Guide topics on Item Specifics and Pre-filled Item Information for information about determining valid attribute IDs. Not applicable to Half.com. AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem AttributeSetArray Conditionally RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem AttributeSetArray No GetItemRecommendations Conditionally GetItem GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally Name of the attribute being specified. This is not part of eBay's standard Item Specifics format (i.e., there is no relationship to GetAttributesCS). For GetOrders, this is always returned for Half.com orders. (It is not applicable to orders on the eBay.com site.) For Half.com, see the eBay Web Services Guide for valid input values. For Half.com, this field is required when you use AddItem. You can revise this value for Half.com listings. AddItem AddItems AddSellingManagerTemplate GetItemRecommendations VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem AttributeArray Conditionally ReviseItem ReviseSellingManagerTemplate AttributeArray No GetOrders
DetailLevel: none, ReturnAll
Always Used for storing an optional reference ID to the binary attachment Stores an optional reference ID to the binary attachment. UploadSiteHostedPictures No Type defining the <b>BestOfferDetails</b> container, which consists of Best Offer details associated with an item. The <b>BestOfferEnabled</b> field in this container is used by Add/Revise/Relist calls to enable the Best Offer feature on a listing. The number of Best Offers made for this item, if any. In other words, if there are no Best Offers made, this container will not appear in the response. GetBidderList GetSellerList Conditionally GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetMyeBaySelling ActiveList
DetailLevel: none, ReturnAll
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally This field indicates whether or not the Best Offer feature is enabled for this item. A seller of a fixed-price item (in a category for which Best Offer is also enabled) can opt that item into the Best Offer feature. This feature enables a buyer to make a lower-priced binding offer on that item. If a listing has no active Best Offers, you can change this value (true to false, and vice versa). If a listing does have an active Best Offer, you cannot change the value to false. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate SetSellingManagerTemplateAutomationRule SetSellingManagerItemAutomationRule VerifyAddItem VerifyRelistItem No GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally DeleteSellingManagerTemplateAutomationRule DeleteSellingManagerItemAutomationRule GetBidderList GetSellingManagerTemplateAutomationRule GetSellingManagerItemAutomationRule SetSellingManagerTemplateAutomationRule SetSellingManagerItemAutomationRule GetSellingManagerTemplates Conditionally This is the amount of the buyer's current Best Offer. This field will not appear in the <b>GetMyeBayBuying</b> response if the buyer has not made a Best Offer. GetMyeBayBuying BestOfferList
DetailLevel: none, ReturnAll
Conditionally This enumeration value indicates the status of the latest Best Offer from the buyer. This field will not appear in the <b>GetMyeBayBuying</b> response if the buyer has not made a Best Offer. GetMyeBayBuying Conditionally BestOfferList
DetailLevel: none, ReturnAll
 Note: this field is no longer used. The Best Offer type is only returned in the BestOfferCodeType field of the GetBestOffers call, and the applicable values for Best Offer type (BuyerBestOffer, BuyerCounterOffer, SellerCounterOffer, etc.) are defined in BestOfferTypeCodeType Enumerated type that defines the possible values for the status of a buyer's Best Offer for an item or a seller's counter offer against the buyer's Best Offer. This value indicates that the buyer's Best Offer on an item is awaiting the seller's response (accept, decline, counter offer). A buyer's Best Offer expires after 48 hours without a seller's response. Depending on context, this value can indicate that the buyer's Best offer was accepted by the seller, or that the seller's counter offer was accepted by the buyer. Depending on context, this value can indicate that the buyer's Best offer was declined by the seller, or that the seller's counter offer was declined by the buyer. Depending on context, this value can indicate that the buyer's Best Offer expired due to the passing of 48 hours with no seller response (accept, decline, counter offer), or that the seller's counter offer expired due to the passing of 48 hours with no buyer response (accept, decline, another Best Offer). Depending on context, this value can indicate that the buyer has retracted the Best Offer, or that the seller has retracted the counter offer. This value indicates that the Best Offer was ended by an eBay administrator. Depending on context, this value can indicate that a buyer's Best Offer or a seller's counter offer is in the active state. The 'Active' value can also be used in the GetBestOffers request to retrieve only the Best Offers in the active state. This value indicates that a buyer's Best Offer has triggered a counter offer from the seller. This value is used in the GetBestOffers request to retrieve all Best Offers in all states. This value indicates that the buyer has accepted the seller's counter offer, but the seller is still awaiting on payment from the buyer. If the buyer does not pay within 48 hours, the counter offer will expire. This value indicates that the seller is waiting on the buyer to commit to buying the item at the counter offer price. (out) Reserved for internal or future use. The offer type of the Best Offer. The buyer has made a Best Offer on the item. The buyer has made a counter offer against the seller's counter offer. The seller has made a counter offer to the buyer's Best Offer. (out) Reserved for internal or future use. Type defining the <b>BiddingDetails</b> container, which consists of information about the buyer's bidding history on a single auction item. Converted value (from seller's currency to buyer's currency) of the amount in the <b>MaxBid<b> field. This field is only applicable and returned if the buyer purchased an item from an eBay site in another country. For active items, it is recommended to refresh the listing's data every 24 hours to pick up the current conversion rates. GetMyeBayBuying BidList LostList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling BidList
DetailLevel: none, ReturnAll
Conditionally This value is the dollar value of the highest bid that the buyer placed on the auction item. GetMyeBayBuying BidList LostList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling BidList
DetailLevel: none, ReturnAll
Conditionally This value is the total number of bids that the buyer placed on the auction item throughout the duration of the listing. GetMyeBayBuying BidList LostList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling BidList
DetailLevel: none, ReturnAll
Conditionally This field will only be returned if the buyer won the auction item, and if it is returned, its value will always be '1'. GetMyeBayBuying BidList LostList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling BidList
DetailLevel: none, ReturnAll
Conditionally (GetMyeBay only) Indicates whether the user is the current high bidder in a currently active listing. The Bid Assistant feature is retired, and this field is scheduled to be removed from BiddingDetailsType. Contains bidding summary information for the bidder of an item. The number of days included in the summary. Currently always set to 30 days. GetAllBidders Conditionally The total number of bids that the bidder has placed. GetAllBidders Conditionally Percentage of the bidder's total bids that the bidder placed on items that the seller is offering. GetAllBidders Conditionally Number of unique sellers whose items the bidder has placed bids on. GetAllBidders Conditionally For items that the bidder has bid on, the number of unique categories that they belong to. GetAllBidders Conditionally The total number of bids that the bidder has retracted. GetAllBidders Conditionally Detail bidding information on the items that the bidder has bid on. GetAllBidders Conditionally Defines supported fields for BrandMPN. The brand of the product. eBay searches against the names that are publicly available in eBay's catalogs. This means you can specify the well-known brand name that an average user would recognize. Specify this in combination with MPN. 4000 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetItem GetItems Conditionally The manufacturer part number of the product. Use the value specified by the manufacturer. (eBay removes special characters and spaces to normalize the values in order to find a match.) 4000 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetItem GetItems Conditionally Enumerated type that defines the eBay user's account type. This value indicates that the eBay user's account is a Partially Provisioned Account without buying and selling privileges on eBay. This value indicates that the eBay user's account is a fully provisioned account with buying and selling privileges on eBay. Displays the seller's information (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. Note that this option is only available for sites that have Business Seller options enabled. Displays the Address of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the fax number of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the email address of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the AdditionalContactInformation of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the TradeRegistrationNumber of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the LegalInvoice of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the TermsAndConditions of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the VATDetails of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 This enumeration type indicates the item's eligibility status for the buyer protection program listed in the <strong>ApplyBuyerProtection.BuyerProtectionSource</strong> field. This value indicates that the item is ineligible for buyer protection. In many cases, the item is ineligible for buyer protection due to the category it is listed under. This value indicates that the item is eligible for buyer protection. This value indicates that the eBay customer support has marked the item as ineligible per special criteria (e.g., seller's account closed). This value indicates that the eBay customer support has marked the item as eligible per special criteria. This value indicates that the item is ineligible for coverage under any buyer protection program. Reserved for internal or future use. Type defining the <strong>ApplyBuyerProtection</strong> container, which consists of details related to whether or not the item is eligibile for buyer protection and which of the buyer protection programs will cover the item. This value indicates the type of buyer protection program applicable for the item. This field is always returned with the <strong>ApplyBuyerProtection</strong> container. GetItemTransactions Conditionally GetOrderTransactions Conditionally GetSellerTransactions Conditionally GetItem GetSellingManagerTemplates Conditionally This value indicates the item's eligibility for the buyer protection program listed in the <strong>ApplyBuyerProtection.BuyerProtectionSource</strong> field. This field is always returned with the <strong>ApplyBuyerProtection</strong> container. GetItemTransactions Conditionally GetOrderTransactions Conditionally GetSellerTransactions Conditionally GetItem GetSellingManagerTemplates Conditionally This enumeration type indicates the applicable buyer protection program that the item is eligible to be covered under. This value indicates that the item is possibly eligible for buyer protection under the eBay Buyer Protection Program. This value indicates that the item is possibly eligible for buyer protection under the PayPal Purchase Protection Program. Reserved for internal or future use. Type defining the <b>BuyerRequirementDetails</b> container, which allows the seller to set buyer requirements at the listing level. For the corresponding listing, all buyer requirement values/settings will overwrite values/settings in Buyer Requirements preferences in My eBay. The seller includes and sets this field to 'true' as a mechanism to block bidders who reside (according to their eBay primary shipping address) in countries that are on the ship-to exclusion list. Sellers add countries or regions to their ship-to exclusion list by adding those countries or regions using one or more <b>ExcludeShipToLocation</b> fields in an Add/Revise/Relist call. false AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally This Buyer Requirements feature is only available to sellers on the China site, and is only applicable to fixed-price or auction Buy It Now items. <br/><br/> The seller includes and sets this field to 'true' as a mechanism to block prospective buyers with a feedback score of 0 from buying items with a price of 100 RMB or higher. false AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The seller includes this field as a mechanism to block bidders who have a Feedback Score less than the specified value. To obtain the list of supported values, call <b>GeteBayDetails</b>, include <b>BuyerRequirementDetails</b> as a <b>DetailName</b> value in the request, and then look for the list of Minimum Feedback Score values returned under the <b>MinimumFeedbackScore</b> container in the response. Currently, the valid values for the US site are -3, -2, and -1. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The seller uses this container as a mechanism to restrict the number of items (specifying a <b>MaximumItemCount</b> value) a prospective buyer can purchase from the seller during a 10-day period. The seller also has the option of setting a <b>MinimumFeedbackScore</b> requirement. If both fields of the <b>MaximumItemRequirements</b> container are set, the <b>MaximumItemCount</b> limit will only apply to those prospective buyers that don't equal or exceed the specified minimum Feedback Score. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The seller includes and sets this field to 'true' as a mechanism to block bidders who do not have a PayPal account linked to their eBay account. false AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The seller uses this container as a mechanism to block prospective buyers who do not pass a verified user check. <br/><br/> This container is only applicable to the following eBay sites: <ul> <li>Australia</li> <li>France</li> <li>India</li> <li>Ireland</li> <li>Spain</li> <li>UK</li> </ul> AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The seller uses this container as a mechanism to block prospective buyers who have one or more unpaid item strikes on their account during a specified time period. false AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The seller uses this container as a mechanism to block prospective buyers who have one or more buyer policy violations on their account during a specified time period. false AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally Contains information about a user as a buyer. Contains the shipping address of the buyer. See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only. GetAllBidders GetHighBidders Always GetBidderList Conditionally GetMyeBaySelling SoldList DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally GetOrderTransactions BuyerInfo
DetailLevel: none, ReturnAll
Conditionally GetSellerList Conditionally HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
 GetItem GetSellingManagerTemplates Conditionally HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally Details of an individual discount profile defined by the user for calculated shipping. The type of discount or "rule" that is being used by the profile. Only WeightOff is a "variable" rule, as defined in the documentation on shipping discount profiles. GetShippingDiscountProfiles IndividualItemWeight, CombinedItemWeight, WeightOff Conditionally SetShippingDiscountProfiles IndividualItemWeight, CombinedItemWeight, WeightOff Conditionally GetItem GetSellingManagerTemplates IndividualItemWeight, CombinedItemWeight, WeightOff
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally UseTopicAlias ShippingDiscountProfiles Details of this particular calculated shipping discount profile. If ModifyActionCode is Modify, all details of the new version of the profile must be provided. If ModifyActionCode is Delete, DiscountProfileID is required, MappingDiscountProfileID is optional, and all other fields of DiscountProfile are ignored. Restrictions of how many profiles you can have for a given discount rule are discussed in the documentation on shipping discount profiles. GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles IndividualItemWeight, CombinedItemWeight, WeightOff Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally UseTopicAlias ShippingDiscountProfiles Details pertinent to one or more items for which calculated shipping (or flat rate shipping using shipping rate tables with weight surcharges) has been offered by the seller, such as package dimension and weight and packaging/handling costs. Also returned with the data for an item's transaction. Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions GetOrders
DetailLevel: none, ReturnAll
Conditionally Specifies the unit type of the weight and dimensions of a shipping package. If MeasurementUnit is used, it overrides the system specified by measurementSystem. If MeasurementUnit and measurementSystem are not specified, the following defaults will be used: <br><br> English: US<br> Metric: CA, CAFR, AU <br><br> CA and CAFR supports both English and Metric, while other sites only support the site's default. <br><br> Use MeasurementUnit with weight and package dimensions. For example, to represent a 5 lbs 2 oz package: <br> &lt;MeasurementUnit&gt;English&lt;/MeasurementUnit&gt; <br> &lt;WeightMajor&gt;5&lt;/WeightMajor&gt; <br> &lt;WeightMinor&gt;2&lt;/WeightMinor&gt; AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem VerifyRelistItem Conditionally UseTopicAlias PackageDetails Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) <br><br> Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetItemTransactions GetSellerTransactions GetOrders
DetailLevel: none, ReturnAll
Conditionally UseTopicAlias PackageDetails Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions GetOrders
DetailLevel: none, ReturnAll
Conditionally UseTopicAlias PackageDetails Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions GetOrders
DetailLevel: none, ReturnAll
Conditionally UseTopicAlias PackageDetails Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetItemTransactions GetSellerTransactions GetOrders
DetailLevel: none, ReturnAll
Conditionally Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions GetOrders
DetailLevel: none, ReturnAll
Conditionally The nature of the package used to ship the item(s). This is required for calculated shipping only. To get the applicable ShippingPackage values for your site, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ShippingPackageDetails</b>, and then look for the ShippingPackageDetails.ShippingPackage fields in the response. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions GetOrders
DetailLevel: none, ReturnAll
Conditionally WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: &lt;WeightMajor unit="lbs"&gt;5&lt;/WeightMajor&gt; &lt;WeightMinor unit="oz"&gt;2&lt;/WeightMinor&gt; See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service. <br><br> For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Required on input when calculated shipping is used. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions GetOrders
DetailLevel: none, ReturnAll
Conditionally See the definition of WeightMajor. For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. (When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation for example, 1 lb, 2 oz is rounded up to 2 lbs.) <br><br> Required on input when calculated shipping is used. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetBidderList GetItemShipping Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions GetOrders
DetailLevel: none, ReturnAll
Conditionally Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetItemShipping GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetItemTransactions GetSellerTransactions GetOrders
DetailLevel: none, ReturnAll
Conditionally Container for data on one listing category. If true, the category supports Best Offers. If not present, the category does not support Best Offers. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Conditionally If true, indicates that the category supports immediate payment. If not present, the category does not support immediate payment. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Conditionally AutoPay UseTopicAlias If true, the category supports business-to-business (B2B) VAT listings. Applicable to the eBay Germany (DE), Austria (AT), and Switzerland CH) sites only. If not present, the category does not support this feature. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Conditionally B2BVAT UseTopicAlias If true, the category supports catalog product details. Not returned if false. GetCategory2CS MappedCategoryArray
DetailLevel: ReturnAll
Conditionally Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID.<br> <br> For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories. 10 AddItem AddItems GetItemRecommendations AddLiveAuctionItem VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem Yes RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No AddSellingManagerTemplate PrimaryCategory Yes AddSellingManagerTemplate SecondaryCategory No GetBidderList PrimaryCategory Always GetBidderList Conditionally FreeAddedCategory SecondaryCategory GetCategories
DetailLevel: ReturnAll
Always GetContextualKeywords Always GetCategory2CS MappedCategoryArray
DetailLevel: ReturnAll
Always GetCategory2CS UnmappedCategoryArray
DetailLevel: ReturnAll
Conditionally GetItem GetSellingManagerTemplates Always PrimaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetItem Conditionally FreeAddedCategory SecondaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Always GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Conditionally GetSuggestedCategories Conditionally GetSellerList Conditionally FreeAddedCategory SecondaryCategory
DetailLevel: ItemReturnDescription, ReturnAll
 GetSellerList Conditionally PrimaryCategory SecondaryCategory
DetailLevel: ItemReturnDescription, ReturnAll
 The level where the category fits in the site's category hierarchy. For example, if this field has a value of 2, then the category is two levels below the root category in the site's category hierarchy. GetCategories
DetailLevel: ReturnAll
Always Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).<br> <br> In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings. 30 GetCategories
DetailLevel: ReturnAll
Always GetContextualKeywords Always GetBidderList Always PrimaryCategory GetBidderList Conditionally FreeAddedCategory SecondaryCategory GetItem GetSellingManagerTemplates Conditionally PrimaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetItem GetSellingManagerTemplates Conditionally FreeAddedCategory SecondaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSuggestedCategories Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally Category ID identifying a category that is an ancestor of the category indicated in CategoryID. For GetCategories, returns the same value as CategoryID if the CategoryLevel is 1. For GetSuggestedCategories, multiple CategoryParentID fields can be returned in sequence, starting with the root category and ending with the category that is the direct parent of the category specified in CategoryID. Use these parent fields and the CategoryID field to build the fully qualified category browse path or "breadcrumbs" (e.g., 58058:3516:3517). 10 GetCategories
DetailLevel: ReturnAll
Always GetSuggestedCategories Conditionally Display name of the category indicated in CategoryParentID. For GetSuggestedCategories, multiple CategoryParentName fields can be returned in sequence, starting with the root category and ending with the category that is the direct parent of the category specified in CategoryName. Use these parent fields and the CategoryName field to build the fully qualified category browse path or "breadcrumbs" (e.g., Computers & Networking > Technology Books > Certification). GetSuggestedCategories Conditionally No longer applicable to any category. 773 Avoid FindProducts (Shopping API) 889 GetCategory2CS MappedCategoryArray
DetailLevel: ReturnAll
Conditionally No longer applicable to any category. 773 Avoid FindProducts (Shopping API) 889 GetCategory2CS MappedCategoryArray
DetailLevel: ReturnAll
Conditionally No longer applicable to any category. 773 Avoid FindProducts (Shopping API) 889 GetCategory2CS MappedCategoryArray SiteWideCharacteristicSets
DetailLevel: ReturnAll
Conditionally If true, indicates a category that has expired and to which items may not be listed. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Always If true, indicates that the category is a fixed-fee category. Use this information to identify categories are not eligible for eBay Stores Inventory format listings. You cannot list eBay Store Inventory format listings in fixed-fee categories on international sites. Output only. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Always If true, indicates that the category indicated in CategoryID is a leaf category, in which items may be listed (if the category is not also expired or virtual). Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Always If true, indicates the category indicated in CategoryID is a virtual category, to which items may not be listed. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Always No longer applicable to any category. No longer supported. 773 Avoid 889 GetCategories
DetailLevel: ReturnAll
Conditionally Indicates whether the category (and its subcategories) allows or disallows listing with a reserve price, depending on the prevailing site configuration indicated by ReservePriceAllowed. ORPA (override reserve price allowed) indicates when the category is an exception to the site's ReservePriceAllowed policy.<br> <br> If ORPA is true, the category overrides (toggles or reverses) the site's ReservePriceAllowed setting. In other words:<br> - If ReservePriceAllowed is true, reserve price is not allowed in this category.<br> - If ReservePriceAllowed is false, reserve price is allowed in this category.<br><br> If ORPA is not present, there is no override. That is, the category's setting is the same as the site's ReservePriceAllowed setting.<br> <br> This field will not be returned in the response if false. This toggling logic is designed to reduce the size of the GetCategories response by only returning ORPA when the category's policy is different from the site's policy. (If ORPA is true for a category, you can assume its subcategories inherit the same setting unless otherwise specified.) GetCategories
DetailLevel: ReturnAll
Always Indicates whether the category (and its subcategories) allows or disallows reducing a listing's reserve price, depending on the prevailing site configuration indicated by ReduceReserveAllowed. ORRA (override reduce reserve allowed) indicates when the category is an exception to the site's ReduceReserveAllowed policy.<br><br> If ORRA is true, the category overrides (toggles or reverses) the site's ReduceReserveAllowed setting. In other words:<br> - If ReduceReserveAllowed is true, reserve price reduction is not allowed in this category.<br> - If ReduceReserveAllowed is false (because it is not present in the response), reserve price reduction is allowed in this category.<br><br> If ORRA is not present, there is no override. Will not be returned in the response if false. That is, the category's setting is the same as the site's ReduceReserveAllowed setting.<br> <br> This toggling logic is designed to reduce the size of the GetCategories response by only returning ORRA when the category's policy is different from the site's policy. (If ORRA is true for a category, you can assume its subcategories inherit the same setting unless otherwise specified.) GetCategories
DetailLevel: ReturnAll
Conditionally "Lot Size Disabled (LSD)" indicates that Item.LotSize is not permitted when you list in this category. If true, indicates that lot sizes are disabled in the specified category. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Always The list of keywords returned. This type is deprecated as the <b>GetProduct*</b> calls are no longer available. Constant value that identifies the characteristic in a language-independent way. Unique within the characteristic set. Applicable when working with Pre-filled Item Information (Catalogs) functionality. Returned if the characteristic is a Date data type. Specifies the pattern to use when presenting the date to a user. Possible values: Day/Month/Year, Month/Year, Year Only. For example, the Year Only format would indicate that the date should be a value like 1999. Output only. The suggested order in which the characteristic should be presented to the user in a list. Indicates the relative position of the sort key in the list of characteristics. The characteristic with the lowest display sequence is considered the default sort key in calls to GetProductSearchResults. Aside from that, usage of this display sequence information is optional. For example, in an application with a graphical user interface, a characteristic with a display sequence of 2 could be presented before one with a display sequence of 3 in a drop-down list. If multiple sort characteristics are returned for a characteristic set, compare their display sequence values to determine the lowest available value (usually 0) and the overall sequence. Applicable when working with Pre-filled Item Information (Catalogs) functionality. The unit of measure (e.g., Inch) to use when the characteristic is numeric indicates a measurement. Not returned if not applicable. Output only. Applicable when working with Pre-filled Item Information (Catalogs) functionality. The label to display when presenting the attribute to a user. Not necessarily the same as the attribute's label as defined in the characteristic set (i.e., the label could be overridden by the catalog). Applicable when working with Pre-filled Item Information (Catalogs) functionality. Indicates the order in which eBay's search engine will sort the results if you pass this characteristic as a sort attribute in GetProductSearchResults. You cannot change the sort order of a characteristic when you perform a search. (Of course, you can change the sort order when you present results in your own application.) In GetProductSearchPage, if SortOrder is not returned at all, it means the results will be returned in the order in which they are stored on eBay (which can be useful for international sites that use ideographic characters). Output only. List of one or more valid values for the characteristic. No longer applicable to any category. 773 Avoid FindProducts (Shopping API) 889 The well-known name of the characteristic set (e.g., "Tickets" or "Books"). GetCategory2CS MappedCategoryArray SiteWideCharacteristicSets
DetailLevel: ReturnAll
Conditionally Numeric value that identifies the characteristic set in a language-independent way. Identifies the characteristic set that is mapped to a catalog-enabled category associated with the product. Unique across all eBay sites. GetCategory2CS
DetailLevel: ReturnAll
Conditionally MappedCategoryArray SiteWideCharacteristicSets GetProductFamilyMembers GetProductSearchPage GetProductSearchResults
DetailLevel: ReturnAll
Always GetProductSellingPages Yes Version of the characteristics set. Not to be confused with AttributeSystemVersion, which can be used to retrieve changes to attribute meta-data. In item-listing requests, if you specify the version of the attribute set that you have stored locally, eBay will compare it to the current version on the site and return a warning if the versions do not match. If an error occurs due to invalid attribute data, this warning can be useful to help determine if you might be sending outdated data. The current value of version is not necessarily "greater than" the previous value. GetCategory2CS
DetailLevel: ReturnAll
Conditionally MappedCategoryArray SiteWideCharacteristicSets A salient aspect or feature of an item. Used to describe an item in a standard way so that buyers can find it more easily. An individual, standardized characteristic that is common to all items within the specified characteristic set. In the context of GetProductSearchPage, each characteristic identifies a single searchable attribute. A searchable attribute is a product aspect or feature that can be used as a criterion in a search for catalog content. For example, "Title" might be a criterion for searching the book catalog for Pre- filled Item Information related to books. See the eBay Web Services guide for more information. GetProductFamilyMembers GetProductSearchPage GetProductSearchResults
DetailLevel: ReturnAll
Always The information of nonprofit charity organization affiliation. The affiliation ID for nonprofit charity organizations registered with the dedicated eBay Giving Works provider. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Indicates the affiliation status of the nonprofit charity organization registered with the eBay Giving Works provider. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Indicates the affiliation last used date of the nonprofit charity organization registered with the eBay Giving Works provider. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Lists the nonprofit charity organization affiliations for a specified user. Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Defines the affiliation status for a nonprofit charity organization registered with the dedicated eBay Giving Works provider. CharityAffiliationTypeCodeType - Type declaration to be used by other schema. Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider. (out) The specified nonprofit charity organization has a community affiliation. (out) The specified nonprofit charity organization has direct affiliation. (out) The specified nonprofit charity organization is no longer affiliated. (out) Reserved for internal or future use. Lists the nonprofit charity organization affiliations for a specified user. Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider. GetBidderList Conditionally GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally NoOp User.SellerInfo.CharityAffiliationDetails.CharityAffiliationDetail.CharityID GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally Defines the affiliation status for a nonprofit charity organization registered with the eBay Giving Works provider. Indicates the affiliation status of the nonprofit charity organization registered with the eBay Giving Works provider. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally CharitySellerStatusCodeType - Type declaration to be used by other schema. Indicates the status of the seller's charity seller account. RegisteredNoCreditCard, DirectDebitRejected The seller's charity seller account is suspended. The seller is a registered charity seller. The seller is no longer a registered charity seller. The account with the eBay Giving Works provider is closed. The credit card associated with a seller's charity seller account has expired. The token associated with a seller's charity seller account has expired. The credit card associated with a seller's charity seller account will expire in 15 (or fewer) days. The seller is no longer a registered charity seller and has lost direct seller status. The seller is a registered direct seller, but has no credit card associated with the charity seller account. The seller is a registered charity seller with no donation payment method on file. Reserved for internal or future use. Contains information about one seller with a eBay Giving Works provider charity seller account. Indicates the status of the seller's charity seller account. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider. Indicates if the seller has accepted eBay GivingWorks Terms and Conditions. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally CharityStatusCodeType - Type declaration to be used by other schema. Indicates the nonprofit status of the nonprofit charity organization registered with the dedicated eBay Giving Works provider. (out) The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider. (out) The specified nonprofit charity organization is no longer a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider. (out) Reserved for internal or future use. Identifies a Giving Works listing and benefiting nonprofit charity organization. Currently supported through the US and eBay Motors sites only. The Ad Format and Mature Audiences categories are not supported. Not applicable for US eBay Motors, international, Real Estate, and Tickets. The name of the benefiting nonprofit charity organization selected by the charity seller. 150 GetBidderList Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally A unique identifier assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. This value can contain up to 10 digits. This value is superseded by CharityID. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is displayed in the Giving Works item listing. Possible values: 10.0 to 100.0. Percentages must increment by 5.0. Minimum donation percentages may be required for Giving Works listings, see http://pages.ebay.com/help/sell/selling-nonprofit.html for details. DonationPercent is required input when listing Giving Works items. AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseSellingManagerTemplate VerifyAddItem AddFixedPriceItem RelistFixedPriceItem VerifyRelistItem Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally A unique identification number assigned by eBay to registered nonprofit charity organizations. Required input when listing Giving Works items. AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseSellingManagerTemplate VerifyAddItem AddFixedPriceItem RelistFixedPriceItem VerifyRelistItem Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally The stated mission of the nonprofit charity organization. This mission is displayed in the Giving Works item listing. 511 GetBidderList Conditionally GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally The URL of the nonprofit charity organization. This URL is displayed in the Giving Works item listing. GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList Conditionally The status of the nonprofit charity organization. GetBidderList Conditionally GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally If true, indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item's purchase price to a selected nonprofit organization. GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the current Checkout status for an order line item. (out) Checkout complete. (out) Checkout incomplete. (out) Buyer requests total from seller. (out) Seller responded to buyer's request. (out) Reserved for future use. Type defining the <b>CheckoutStatus</b> container that is returned in <b>GetOrders</b> and <b>GetOrderTransactions</b> to indicate the current checkout status of the order. This value indicates the payment status of an order. <br><br> Also applicable to Half.com orders (GetOrders only). GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always SoldReport Always Indicates the last time that there was a change in value of the <b>CheckoutStatus.Status</b> field, such as 'Pending' to 'Complete'. <br><br> This field is also applicable to Half.com orders (GetOrders only). GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always The payment method that the buyer selected to pay for the order. <br> <br> This field is also applicable to Half.com orders (GetOrders only). GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always SoldReport Always Indicates the status of the order. This value is subject to change based on the status of the checkout flow. Generally speaking, the <b>Status</b> field reads 'Incomplete' when payment has yet to be initiated, 'Pending' when payment has been initiated but is in process, and 'Complete' when the payment process has completed. <br><br> <b>Note</b>: If the PaymentMethod is CashOnPickup, the Status value will read Complete right at Checkout, even though the seller may not have been officially paid yet, and the eBayPaymentStatus field will read NoPaymentFailure. The CheckoutStatus.Status value will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess. <br><br> This field is also applicable to Half.com orders (GetOrders only). GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always SoldReport Always Indicates whether the item can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account. GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always This container is returned when a buyer's payment does not match the total cost of an order going through the new eBay payment process. This container is only applicable for German and Austrian orders going through the new eBay payment process, and if the buyer has selected EFT as the payment method. <br> <br> <span class="tablenote"><b>Note:</b> The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.</span> GetOrders
DetailLevel: none, ReturnAll
Conditionally GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ReturnAll
Conditionally GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally Indicates whether the order is complete, incomplete, or pending. The order is incomplete. Generally speaking, an order is incomplete when payment from the buyer has yet to be initiated. The order is complete. Generally speaking, an order is complete when payment from the buyer has been initiated and processed. <br><br> <b>Note</b>: If the <b>PaymentMethodUsed</b> is 'CashOnPickup', the <b>CheckoutStatus.Status</b> value in <b>GetOrders</b> will be 'Complete' right at Checkout, even though the seller may not have been officially paid yet. The <b>CheckoutStatus.Status</b> value in <b>GetOrders</b> will remain as 'Complete' even if the seller uses <b>ReviseCheckoutStatus</b> to change the checkout status to Pending. However, the <b>eBayPaymentStatus</b> value in <b>GetOrders</b> will change from 'NoPaymentFailure' to 'PaymentInProcess'. The order is pending. Generally speaking, an order is pending when payment from the buyer has been initiated but has yet to be fully processed. <br><br> <b>Note</b>: If the PaymentMethod is CashOnPickup, the CheckoutStatus.Status value in GetOrders will read Complete right at Checkout, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess. Reserved for internal or future use Contains the data for primary and secondary contact hours for a given eBay user. Indicates the local time zone of the values provided for Hours1From/Hours1To and Hours2From/Hours2To. If you specify a contact hours time range with Hours1From and Hours1To, you must provide a local time zone. To retrieve a complete list of the TimeZoneID values supported by eBay, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>TimeZoneDetails</b>. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the range of days for which the primary contact hours specified by Hours1AnyTime or Hours1From and Hours1To apply. If a value of None is provided for this field, the values provided for Hours1AnyTime, Hours1From, Hours1To are ignored. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours1Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours1From and Hours1To will be ignored. In the case of this field being false, the values provided Hours1From and Hours1To will be considered. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the range of days for which the secondary contact hours specified by Hours2AnyTime or Hours2From and Hours2To apply. If a value of None is provided for this field, the values provided for Hours2AnyTime, Hours2From, Hours2To are ignored. <br> <b>Note:</b> You cannot set Hours2Days to EveryDay. If Hours1Days is set to EveryDay, secondary contact hours do not apply. Hours2Days cannot be set to the same value as Hours1Days. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours2Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours2From and Hours2To will be ignored. In the case of this field being false, the values provided Hours2From and Hours2To will be considered. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours2Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Defines the 2-letter country code set. <br><br> Use the GeteBayDetails call to see the list of currently supported codes, and the English names associated with each code (e.g., KY="Cayman Islands"), call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>Country</b>. <br><br> Most of the codes that eBay uses conform to the ISO 3166 standard, but some of the codes in the ISO 3166 standard are not used by eBay. Plus, there are some non-ISO codes in the eBay list. (Additional codes appear at the end of this code list and are noted as non-ISO.) QP Afghanistan. Albania. Algeria. American Samoa. Andorra. Angola. Anguilla. Antarctica. Antigua and Barbuda. Argentina. Armenia. Aruba. Australia. Austria. Azerbaijan. Bahamas. Bahrain. Bangladesh. Barbados. Belarus. Belgium. Belize . Benin. Bermuda. Bhutan. Bolivia. Bosnia and Herzegovina. Botswana. Bouvet Island. Brazil. British Indian Ocean Territory. Brunei Darussalam. Bulgaria. Burkina Faso. Burundi. Cambodia. Cameroon. Canada. Cape Verde. Cayman Islands. Central African Republic. Chad. Chile. China. Christmas Island. Cocos (Keeling) Islands. Colombia. Comoros. Congo. Congo, The Democratic Republic of the. Cook Islands. Costa Rica. Cote d'Ivoire. Croatia. Cuba. Cyprus. Czech Republic. Denmark. Djibouti. Dominica. Dominican Republic. No longer in use. Ecuador. Egypt. El Salvador. Equatorial Guinea. Eritrea. Estonia. Ethiopia. Falkland Islands (Malvinas). Faroe Islands. Fiji. Finland. France. French Guiana. French Polynesia. Includes Tahiti. French Southern Territories. Gabon. Gambia. Georgia. Germany. Ghana. Gibraltar. Greece. Greenland. Grenada. Guadeloupe. Guam. Guatemala. Guinea. Guinea-Bissau. Guyana. Haiti. Heard Island and Mcdonald Islands. Holy See (Vatican City state). Honduras. Hong Kong. Hungary. Iceland. India. Indonesia. Iran, Islamic Republic of. Iraq. Ireland. Israel. Italy. Jamaica. Japan. Jordan. Kazakhstan. Kenya. Kiribati. Korea, Democratic People's Republic of. Korea, Republic of. Kuwait. Kyrgyzstan. Lao People's Democratic Republic. Latvia. Lebanon. Lesotho. Liberia. Libyan Arab Jamahiriya. Liechtenstein. Lithuania. Luxembourg. Macao. Macedonia, the Former Yugoslav Republic of. Madagascar. Malawi. Malaysia. Maldives. Mali. Malta. Marshall Islands. Martinique. Mauritania. Mauritius. Mayotte. Mexico. Micronesia, Federated States of. Moldova, Republic of. Monaco. Mongolia. Montserrat. Morocco. Mozambique. Myanmar. Namibia. Nauru. Nepal. Netherlands. Netherlands Antilles. New Caledonia. New Zealand. Nicaragua. Niger. Nigeria. Niue. Norfolk Island. Northern Mariana Islands. Norway. Oman. Pakistan. Palau. Palestinian territory, Occupied. Panama. Papua New Guinea. Paraguay. Peru. Philippines. Pitcairn. Poland. Portugal. Puerto Rico. Qatar. Reunion. Romania. Russian Federation. Rwanda. Saint Helena. Saint Kitts and Nevis. Saint Lucia. Saint Pierre and Miquelon. Saint Vincent and the Grenadines. Samoa. San Marino. Sao Tome and Principe. Saudi Arabia. Senegal. Seychelles. Sierra Leone. Singapore. Slovakia. Slovenia. Solomon Islands. Somalia. South Africa. South Georgia and the South Sandwich Islands. Spain. Sri Lanka. Sudan. Suriname. Svalbard and Jan Mayen. Swaziland. Sweden. Switzerland. Syrian Arab Republic. Taiwan, Province of China. Tajikistan. Tanzania, United Republic of. Thailand. Togo. Tokelau. Tonga. Trinidad and Tobago. Tunisia. Turkey. Turkmenistan. Turks and Caicos Islands. Tuvalu. Uganda. Ukraine. United Arab Emirates. United Kingdom. United States. NOTE: United States Minor Outlying Islands was defined in the eBay list previously but is no longer a viable option. This country will remain on eBay country list for backward compatibility. Use 'US' instead. Uruguay. Uzbekistan. Vanuatu. Venezuela. Viet Nam. Virgin Islands, British. Virgin Islands, U.S. Wallis and Futuna. Western Sahara. Yemen. No longer in use. See RS for Serbia and ME for Montenegro. Zambia. Zimbabwe. NOTE: APO/FPO was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country code list for backward compatibility. NOTE : Guernsey was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. NOTE: Jan Mayen was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. NOTE: Jersey was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. Jersey Guernsey Unknown country Serbia Montenegro. (out) Reserved for internal or future use eBay Store Cross Promotions are no longer supported in the Trading API, so the <b>CrossPromotion</b> container will either not be returned, or, if it is returned, the data in the container may not be accurate. Contains one or more items cross-promoted with the display or purchase of a referring item. Unique item ID for the referring item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetCrossPromotions Always The primary cross-promotion rule scheme that was applied to return the cross-promoted item. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetCrossPromotions Always The type of promotion, CrossSell or UpSell. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetCrossPromotions Always The eBay user ID of the seller offering the cross-promoted item. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetCrossPromotions Always Whether a shipping discount is offered by the seller when the cross-promoted item is purchased. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetCrossPromotions Always The store name of the seller offering the cross-promoted item. GetCrossPromotions Conditionally Contains one cross-promoted item. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetCrossPromotions Conditionally This enumeration type contains a list of standard 3-digit ISO 4217 currency codes for currency used in countries around the world. <br/><br/> When adding an item through <b>AddItem</b> (or related API call), the <b>Item.Currency</b> value will default to the currency used on the listing site. Otherwise, only the following currency types may be specified through an Add/Revise/Relist call, since these are the currencies of all the countries where the Trading API is supported: <ul> <li>USD - US Dollar</li> <li>CAD - Canadian Dollar</li> <li>GBP - British Pound</li> <li>AUD - Australian Dollar</li> <li>EUR - Euro</li> <li>CHF - Swiss Franc</li> <li>CNY - Chinese Renminbi</li> <li>HKD - Hong Kong Dollar</li> <li>PHP - Philippines Peso</li> <li>PLN - Polish Zloty</li> <li>SEK - Sweden Krona</li> <li>SGD - Singapore Dollar</li> <li>TWD - Taiwanese Dollar</li> <li>INR - Indian Rupee</li> <li>MYR - Malaysian Ringgit</li> </ul> <br/> Other currency codes in this enumerated type may be returned in <b>GetItem</b> (and other calls) based on the buyer's and/or seller's registration country. However, only the values listed above will be returned if you call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>CurrencyDetails</b>. http://www.xe.com/iso4217.htm This value is a 3-digit code for an Afghan afghani, a currency used in Afghanistan. This value is a 3-digit code for an Albanian lek, a currency used in Albania. This value is a 3-digit code for an Algerian dinar, a currency used in Algeria. This value is a 3-digit code for an Andorran peseta, a currency used in Andorra. This value is a 3-digit code for an Angolan kwanza, a currency used in Angola. This value is a 3-digit code for an Argentine peso, a currency used in Argentina. This value is a 3-digit code for an Armenian dram, a currency used in Armenia. This value is a 3-digit code for an Aruban florin, a currency used in Aruba. This value is a 3-digit code for an Azerbaijani manat, a currency used in Azerbaijan. This value is a 3-digit code for a Bahamian dollar, a currency used in the Bahamas. This value is a 3-digit code for a Bahraini dinar, a currency used in the Bahrain. This value is a 3-digit code for a Bangladeshi taka, a currency used in Bangladesh. This value is a 3-digit code for a Barbados dollar, a currency used in Barbados. This value is a 3-digit code for a Belarusian ruble, a currency used in Belarus. This value is a 3-digit code for a Belize dollar, a currency used in Belize. This value is a 3-digit code for a Bermudian dollar, a currency used in Bermuda. This value is a 3-digit code for a Bhutanese ngultrum, a currency used in Bhutan. This value is a 3-digit code for an Indian rupee, a currency used in India. This is the value that should be passed in the <b>Item.Currency</b> field by the seller when listing an item on the eBay India site (Site ID 203). This value is a 3-digit code for a Bolivian Mvdol, a currency used in Bolivia. This value is a 3-digit code for a Boliviano, a currency used in Bolivia. This value is a 3-digit code for a Bosnia and Herzegovina convertible mark, a currency used in Bosnia and Herzegovina. This value is a 3-digit code for a Botswana pula, a currency used in Botswana. This value is a 3-digit code for a Brazilian real, a currency used in Brazil. This value is a 3-digit code for a Brunei dollar, a currency used in Brunei and Singapore. This value is a 3-digit code for the old Bulgarian lev, a currency previously used in Bulgaria. This currency has been replaced by the new Bulgarian lev (3-digit code: BGN). This value is a 3-digit code for a Bulgarian lev, a currency used in Bulgaria. This currency replaced the old Bulgarian lev (3-digit code: BGL). This value is a 3-digit code for a Burundian franc, a currency used in Burundi. This value is a 3-digit code for a Cambodian riel, a currency used in Cambodia. This value is a 3-digit code for a Canadian dollar, a currency used in Canada. This is the value that should be passed in the <b>Item.Currency</b> field by the seller when listing an item on the eBay Canada site (Site ID 2). Note that items listed on the Canada site can also specify 'USD'. This value is a 3-digit code for a Cape Verde escudo, a currency used in Cape Verde. This value is a 3-digit code for a Cayman Islands dollar, a currency used in the Cayman Islands. This value is a 3-digit code for a Central African CFA franc, a currency used in Cameroon, Central African Rebublic, Republic of the Congo, Chad, Equatorial Guinea, and Gabon. This value is a 3-digit code for a Unidad de Fomento, a currency used in Chile. This value is a 3-digit code for a Chilean peso, a currency used in Chile. This value is a 3-digit code for a Chinese yuan (also known as the renminbi), a currency used in China. This value is a 3-digit code for a Columbian peso, a currency used in Columbia. This value is a 3-digit code for a Comoro franc, a currency used in Comoros. This value is a 3-digit code for a Congolese franc, a currency used in Democratic Republic of Congo. This value is a 3-digit code for a Costa Rican colon, a currency used in Costa Rica. This value is a 3-digit code for a Croatian kuna, a currency used in Croatia. This value is a 3-digit code for a Cuban peso, a currency used in Cuba. This value is a 3-digit code for a Cypriot pound, a currency previously used in Cyprus. This currency has been replaced by the Euro (3-digit code: EUR). This value is a 3-digit code for a Czech koruna, a currency used in the Czech Republic. This value is a 3-digit code for a Danish krone, a currency used in Denmark, the Faroe Islands, and Greenland. This value is a 3-digit code for a Djiboutian franc, a currency used in Djibouti. This value is a 3-digit code for a Dominican peso, a currency used in the Dominican Republic. This value is a 3-digit code for a Portuguese Timorese escudo, a currency previously used in Portuguese Timor. This value is an old 3-digit code for a Cape Verde escudo, a currency used in Cape Verde. The 'ECV' code has been replaced by 'CVE'. This value is a 3-digit code for an Ecuadorian sucre, a currency previously used in Ecuador. This currency has been replaced by the US Dollar (3-digit code: USD). This value is a 3-digit code for an Egyptian pound, a currency used in Egypt. This value is a 3-digit code for a Salvadoran colon, a currency previously used in El Salvador. This currency has been replaced by the US Dollar (3-digit code: USD). This value is a 3-digit code for an Eritrean nakfa, a currency used in Eritrea. This value is a 3-digit code for an Estonian kroon, a currency previously used in Estonia. This currency has been replaced by the Euro (3-digit code: EUR). This value is a 3-digit code for an Ethiopian birr, a currency used in Ethiopia. This value is a 3-digit code for a Falkland Islands pound, a currency used in the Falkland Islands. This value is a 3-digit code for a Fiji dollar, a currency used in Fiji. This value is a 3-digit code for a Gambian dalasi, a currency used in Gambia. This value is a 3-digit code for a Georgian Iari, a currency used in the country of Georgia. This value is an old 3-digit code for a Ghanaian cedi, a currency used in Ghana. The 'GHC' code has been replaced by 'GHS'. This value is a 3-digit code for a Gibraltar pound, a currency used in Gibraltar. This value is a 3-digit code for a Guatemalan quetzal, a currency used in Guatemala. This value is a 3-digit code for a Guinean franc, a currency used in Guinea. This value is a 3-digit code for a Guinea-Bissau peso, a currency previously used in Guinea-Bissau. This currency has been replaced by the West African CFA franc (3-digit code: XOF). This value is a 3-digit code for a Guyanese dollar, a currency used in Guyana. This value is a 3-digit code for a Haitian gourde, a currency used in Haiti. This value is a 3-digit code for a Honduran lempira, a currency used in Honduras. This value is a 3-digit code for a Hong Kong dollar, a currency used in Hong Kong and Macau. This is the value that should be passed in the <b>Item.Currency</b> field by the seller when listing an item on the eBay Hong Kong site (Site ID 201). This value is a 3-digit code for a Hungarian forint, a currency used in Hungary. This value is a 3-digit code for an Icelandic krona, a currency used in Iceland. This value is a 3-digit code for an Indonesian rupiah, a currency used in Indonesia. This value is a 3-digit code for an Iranian rial, a currency used in Iran. This value is a 3-digit code for an Iraqi dinar, a currency used in Iraq. This value is a 3-digit code for an Israeli new shekel, a currency used in Israel and in the Palestinian territories. This value is a 3-digit code for a Jamaican dollar, a currency used in Jamaica. This value is a 3-digit code for a Japanese yen, a currency used in Japan. This value is a 3-digit code for a Jordanian dinar, a currency used in Jordan. This value is a 3-digit code for a Kazahhstani tenge, a currency used in Kazakhstan. This value is a 3-digit code for a Kenyan shilling, a currency used in Kenya. This value is a 3-digit code for an Australia dollar, a currency used in Australia. This is the value that should be passed in the <b>Item.Currency</b> field by the seller when listing an item on the eBay Australia site (Site ID 15). This value is a 3-digit code for a North Korean won, a currency used in North Korea. This value is a 3-digit code for a South Korean won, a currency used in South Korea. This value is a 3-digit code for a Kuwaiti dollar, a currency used in Kuwait. This value is a 3-digit code for a Kyrgzstani som, a currency used in Kyrgystan. This value is a 3-digit code for a Lao kip, a currency used in Laos. This value is a 3-digit code for a Latvian lats, a currency used in Latvia. This value is a 3-digit code for a Lebanese pound, a currency used in Lebanon. This value is a 3-digit code for a Lesotho loti, a currency used in Lesotho. This value is a 3-digit code for a Liberian dollar, a currency used in Liberia. This value is a 3-digit code for a Libyan dinar, a currency used in Libya. Swiss Franc. For eBay, you can only specify this currency for listings you submit to the Switzerland site (site ID 193). This value is a 3-digit code for a Lithuanian litas, a currency used in Lithuania. This value is a 3-digit code for a Macanese pataca, a currency used in Macao. This value is a 3-digit code for a Macedonian denar, a currency used in Macedonia. This value is a 3-digit code for a Malagay franc, a currency previously used in Madagascar. This currency has been replaced by the Malagasy ariary (3-digit code: MGA). This value is a 3-digit code for a Malawian kwacha, a currency used in Malawi. This value is a 3-digit code for a Malaysian Ringgit, a currency used in Malaysia. This is the value that should be passed in the <b>Item.Currency</b> field by the seller when listing an item on the eBay Malaysia site (Site ID 207). This value is a 3-digit code for a Maldivian rufiyaaa, a currency used in the Maldives. This value is a 3-digit code for a Maltese lira, a currency previously used in Malta. This currency has been replaced by the Euro (3-digit code: EUR). This value is a 3-digit code for a EURO, a currency used in Andorra, Austria, Belgium, Cyprus, Estonia, Finland, France, Germany, Greece, Ireland, Italy, Kosovo, Luxembourg, Malta, Monaco, Montenegro, Netherlands, Portugal, San Marino, Slovakia, Slovenia, Spain, and Vatican City. This is the value that should be passed in the <b>Item.Currency</b> field by the seller when listing an item on the following sites: Austria (Site ID 16), Belgium_French (Site ID 23), France (Site ID 71), Germany (Site ID 77), Italy (Site ID 101), Belgium_Dutch (Site ID 123), Netherlands (Site ID 146), Spain (Site ID 186), and Ireland (Site ID 205). This value is a 3-digit code for a Mauritanian ouguiya, a currency used in Mauritania. This value is a 3-digit code for a Mauritian rupee, a currency used in Mauritius. This value is a 3-digit code for a Mexican peso, a currency used in Mexico. This value is a 3-digit funds code for a Mexican peso, a currency used in Mexico. This value is a 3-digit code for a Moldovan leu, a currency used in Moldova. This value is a 3-digit code for a Mongolian tugrik, a currency used in Mongolia. This value is a 3-digit code for an Easy Caribbean dollar, a currency used in Anguilla, Antigua and Barbuda, Dominica, Grenada, Montserrat, Saint Kitts and Nevis, Saint Lucia, and Saint Vincent and the Grenadines. This value is an old 3-digit code for a Mozambican metical, a currency used in Mozambique. The 'MZM' code has been replaced by 'MZN'. This value is a 3-digit code for a Myanma kyat, a currency used in Myanmar. This value is a 3-digit code for a South African rand, a currency used in South Africa. This value is a 3-digit code for a Namibian dollar, a currency used in Namibia. This value is a 3-digit code for a Nepalese rupee, a currency used in Nepal. This value is a 3-digit code for a Netherlands Antillean guilder, a currency used in Curacao and Sint Maarten. This value is a 3-digit code for a CFP franc, a currency used in French Polynesia, New Caledonia, and Wallis and Futuna. This value is a 3-digit code for a New Zealand dollar, a currency used in the Cook Islands, New Zealand, Niue, Pitcairn, and Tokelau, Ross Dependency. This value is a 3-digit code for a Nicaraguan cordoba, a currency used in Nicaragua. This value is a 3-digit code for a Nigerian naira, a currency used in Nigeria. This value is a 3-digit code for a Norwegian kron, a currency used in Norway, Svalbard, Jan Mayen, Bouvet Island, Queen Maud Land, and Peter I Island. This value is a 3-digit code for an Omani rial, a currency used in Oman. This value is a 3-digit code for a Pakistani rupee, a currency used in Pakistan. This value is a 3-digit code for a Panamanian balboa, a currency used in Panama. This value is a 3-digit code for a Papua New Guinea kina, a currency used in Papua New Guinea. This value is a 3-digit code for a Paraguayan guarani, a currency used in Paraguay. This value is a 3-digit code for a Peruvian nuevo sol, a currency used in Peru. This value is a 3-digit code for a Philippine peso, a currency used in the Philippines. This is the value that should be passed in the <b>Item.Currency</b> field by the seller when listing an item on the eBay Philippines site (Site ID 211). This value is a 3-digit code for a Polish zloty, a currency used in Poland. This is the value that should be passed in the <b>Item.Currency</b> field by the seller when listing an item on the eBay Poland site (Site ID 212). This value is a 3-digit code for a US dollar, a currency used in the United States, America Samoa, Barbados, Bermuda, British Indian Ocean Territory, British Virgin Islands, Caribbean Netherlands, Ecuador, El Salvador, Guam, Haiti, Marshall Islands, Federated States of Micronesia, Northern Mariana Islands, Palau, Panama, Puerto Rico, Timor-Leste, Turks and Caicos Islands, US Virgin Islands, and Zimbabwe. This is the value that should be passed in the <b>Item.Currency</b> field by the seller when listing an item on the eBay US site (Site ID 0) or eBay US Motors site (Site ID 100). 'USD' can also be specified as the <b>Item.Currency</b> on the eBay Canada site (Site ID 2). This value is a 3-digit code for a Qatari riyal, a currency used in Qatar. This value is a 3-digit code for the old Romanian leu, a currency previously used in Romania. This currency has been replaced by the Romanian new leu (3-digit code: RON). This value is a 3-digit code for a Russian rouble, a currency used in Russia, Abkhazia, and South Ossetia. This value replace the old 3-digit code for the Russian rouble, 'RUR'. This value is the old 3-digit code for a Russian rouble, a currency used in Russia. This value was replaced by the new 3-digit code for the Russian rouble, 'RUB'. This value is a 3-digit code for a Rwandan franc, a currency used in Rwanda. This value is a 3-digit code for a Saint Helena pound, a currency used in Saint Helena. This value is a 3-digit code for a Samoan tala, a currency used in Samoa. This value is a 3-digit code for a Sao Tome and Principe dobra, a currency used in Sao Tome and Principe. This value is a 3-digit code for a Saudi riyal, a currency used in Saudi Arabia. This value is a 3-digit code for a Seychelles rupee, a currency used in Seychelles. This value is a 3-digit code for a Sierra Leonean leone, a currency used in Sierra Leone. This value is a 3-digit code for a Singapore dollar, a currency used in Singapore and Brunei. This is the value that should be passed in the <b>Item.Currency</b> field by the seller when listing an item on the eBay Singapore site (Site ID 216). This value is a 3-digit code for a Slovak koruna, a currency previously used in Slovakia. This currency has been replaced by the Euro (3-digit code: EUR). This value is a 3-digit code for a Slovenian tolar, a currency previously used in Slovenia. This currency has been replaced by the Euro (3-digit code: EUR). This value is a 3-digit code for a Solomon Islands dollar, a currency used in the Solomon Islands. This value is a 3-digit code for a Somali shilling, a currency used in Somalia. This value is a 3-digit code for a Sri Lankan rupee, a currency used in Sri Lanka. This value is the 3-digit code for a Sudanese dinar, a currency previously used in Sudan. The Sudanese dinar was replaced by the Sudanese pound, which has a 3-digit code of 'SDG'. This value is the 3-digit code for a Suriname guilder, a currency previously used in Suriname. The Surinam guilder was replaced by the Surinamese dollar, which has a 3-digit code of 'SRD'. This value is a 3-digit code for a Swazi lilangeni, a currency used in Swaziland. This value is a 3-digit code for a Swedish krona, a currency used in Swedn. This is the value that should be passed in the <b>Item.Currency</b> field by the seller when listing an item on the eBay Sweden site (Site ID 218). This value is a 3-digit code for a Syrian pound, a currency used in Syria. This value is a 3-digit code for the New Taiwan dollar, a currency used in Taiwan. This value is a 3-digit code for a Tajikistani somoni, a currency used in Tajikistan. This value is a 3-digit code for a Tanzanian shilling, a currency used in Tanzania. This value is a 3-digit code for a Thai baht, a currency used in Thailand. This value is a 3-digit code for a West African CFA franc, a currency used in Benin, Burkina Faso, Cote d'Ivoire, Guinea-Bissau, Mali, Niger, Senegal, and Togo. This value is a 3-digit code for a Tongan pa'anga, a currency used in Tonga. This value is a 3-digit code for a Trinidad and Tobago dollar, a currency used in Trinidad and Tobago. This value is a 3-digit code for a Tunisian dinar, a currency used in Tunisia. This value is the old 3-digit code for a Turkish lira, a currency used in Turkey and Northern Cyprus. This value was replaced by the new 3-digit code for the Turkish lira, 'TRY'. This value is the old 3-digit code for a Turkmenistani manat, a currency used in Turkmenistan. This value was replaced by the new 3-digit code for the Turkmenistani manat, 'TMT'. This value is a 3-digit code for a Ugandan shilling, a currency used in Uganda. This value is a 3-digit code for a Ukrainian hryvnia, a currency used in the Ukraine. This value is a 3-digit code for an United Arab Emirates dirham, a currency used in the United Arab Emirates. This value is a 3-digit code for a Pound sterling, a currency used in the United Kingdom and British Crown dependencies. This is the value that should be passed in the <b>Item.Currency</b> field by the seller when listing an item on the eBay UK site (Site ID 3). This value is a 3-digit code for a same-day transaction involving US dollars. This value is a 3-digit code for a next-day transaction involving US dollars. This value is a 3-digit code for a Uruguayan peso, a currency used in Uruguay. This value is a 3-digit code for a Uzbekistan som, a currency used in the Uzbekistan. This value is a 3-digit code for a Vanuatu vatu, a currency used in Vanuatu. This value is a 3-digit code for a Venezuelan bolivar, a currency previously used in Venezuela. The Venezuela bolivar was replaced by the Venezuelan bolivar fuerte, which has a 3-digit code of 'VEF'. This value is a 3-digit code for a Vietnamese dong, a currency used in Vietnam. This value is a 3-digit code for a Moroccan dirham, a currency used in Morocco. This value is a 3-digit code for a Yemeni rial, a currency used in Yemen. This value is a 3-digit code for a Yugoslav dinar, a currency previously used in Yugoslavia. The Yugoslav dinar was replaced by the Serbian dinar, which has a 3- digit code of 'RSD'. This value is the old 3-digit code for a Zambian kwacha, a currency used in Zambia. The 'ZMK' code has been replaced by 'ZMW'. This value is the old 3-digit code for a Zimbabwean dollar, a currency previously used in Zimbabwe. The US dollar replaced the Zimbabwean dollar as the official currency in Zimbabwe. This value is a 3-digit code for an Austrian schilling, a currency previously used in Austria. This currency has been replaced by the Euro (3-digit code: EUR). Reserved for internal or future use. Specifies the range of days the seller can be contacted. Seller does not want to be contacted. Contact hours will not be supported for any days. If contact hours are specified, they will be ignored. Seller can be contacted any day during the specified contact hours. Seller can be contacted Monday through Friday during the specified contact hours. Seller can be contacted Saturday or Sunday during the specified contact hours. (out) Reserved for internal or future use. For vehicles listed through the US eBay Motors site, DepositType indicates how the buyer should pay the deposit amount. It is used in conjunction with a buyer payment method (BuyerPaymentMethodCodeType). (out) No deposit needed. (out) Pay the deposit using PayPal, and then use any of the other specified payment methods to pay the balance. (out) No longer used. (out) Reserved for internal or future use Enumerated type containing the list of values that can be used when revising the item description of an active listing through the Revise API calls. Use this value in the <b>Item.DescriptionReviseMode</b> field if you want to completely replace (overwrite) the item description of the active listing. Use this value in the <b>Item.DescriptionReviseMode</b> field if you want to prepend text to the item description of the active listing. Use this value in the <b>Item.DescriptionReviseMode</b> field if you want to append text to the item description of the active listing. This value is reserved for internal or future use. The type of shipping discount profile. The cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalAmount to $6. The cost to ship three items would normally be $24, but since the seller specified $6, the total shipping cost would be $8 + $6 + $6, or $20. For flat shipping discount profile only. The amount by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalAmountOff to $2. The cost to ship three items would normally be $24, but since the seller specified $2, the total shipping cost would be $24 - (two additional items x $2), or $20. For flat shipping discount profile only. The percentage by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalPercentOff to 0.25. The cost to ship three items would normally be $24, but since the seller specified 0.25 ($2 out of 8), the total shipping cost would be $24 - (two additional items x $2), or $20. For flat rate shipping discount profile only. Shipping cost is the total of what it would cost to ship each item individually. This is simply a way to define how shipping is to be calculated--there is no discount for the buyer with this selection. For calculated shipping discount profile only. Shipping cost is based on the total weight of all individual items. This is simply a way to define how shipping is to be calculated--there is no discount for the buyer with this selection. For calculated shipping discount profile only. The amount of weight to subtract for each item beyond the first item before shipping costs are calculated. For example, there may be less packing material when the items are combined in one box than if they were shipped individually. Let's say the buyer purchases three items, each 10 oz. in weight, and the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since the seller specified 2 oz. off, the total weight for shipping cost calculation would be 30 oz. - (two additional items x 2 oz.), or 26 oz. For calculated shipping discount profile only. Shipping cost X applies if the total cost of items purchased is Y. For promotional discount only. Shipping cost X applies if the total number of items purchased is N. For promotional discount only. The shipping cost will not exceed this. For promotional discount only. Reserved for internal or future use. Using this container, a seller can supply original retail price and discount price for an item to clarify the discount treatment (also known as strike-through pricing). This only applies to fixed-price listings and auction listings with the Buy It Now option. This feature is available for large enterprise sellers via white list. A seller can provide discount treatment regardless of whether the listing includes a SKU. The actual retail price set by the manufacturer (OEM). eBay does not maintain or validate the OriginalRetailPrice supplied by the seller. OriginalRetailPrice should always be more than StartPrice. Compare the StartPrice/BuyItNowPrice to OriginalRetailPrice to determine the amount of savings to the buyer. AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem Conditionally AddItem ReviseItem RelistItem VerifyAddItem Conditionally GetItem Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally Minimum Advertised Price (MAP) is an agreement between suppliers (or manufacturers (OEM)) and the retailers (sellers) stipulating the lowest price an item is allowed to be advertised at. Sellers can offer prices below MAP by means of other discounts. This only applies to fixed-price listings and auction listings with the Buy It Now option. AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem Conditionally AddItem ReviseItem RelistItem VerifyAddItem Conditionally GetItem Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally For MinimumAdvertisedPrice (MAP) listings only. A seller cannot show the actual discounted price on eBay's View Item page. Instead, the buyer can either click on a pop-up on eBay's View Item page, or the discount price will be shown during checkout. AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem Conditionally AddItem ReviseItem RelistItem VerifyAddItem Conditionally GetItem Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally Based on OriginalRetailPrice, MinimumAdvertisedPrice, and StartPrice values, eBay identifies whether the listing falls under MAP or STP (aka OriginalRetailPrice). GetItem returns this for items listed with one of these discount pricing treatments. GetSellerList returns the DiscountPriceInfo container. This field is not applicable for Add/Revise/Relist calls. GetItem Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally false Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on eBay within the previous 30 days. The discount price is always in reference to the seller's own price for the item. <br><br> If this field is set to 'true', eBay displays 'Was' in the UK and 'Ursprunglich' in Germany, next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields are set to 'true', SoldOneBay takes precedence. AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem Conditionally AddItem ReviseItem RelistItem VerifyAddItem Conditionally GetItem Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally false Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on a Web site or offline store other than eBay in the previous 30 days. The discount price is always in reference to the seller's own price for the item. <br><br> If this field is set to 'true', eBay displays 'Was*' in the UK and 'Ursprunglich*' in Germany, next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields are set, SoldOneBay takes precedence. AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem Conditionally AddItem ReviseItem RelistItem VerifyAddItem Conditionally GetItem Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally false Applicable only if the item was specifically made for sale through dedicated eBay outlet pages (e.g., eBay Fashion Outlet).<br> <br> The comparison price is the price of a comparable product sold through non-outlet channels on eBay (or elsewhere), or not specifically made for the outlet.<br> <br> In fashion, a "comparable" product shares the same design, but is not considered an identical product. Some products are specifically made for outlets, and may have a different SKU than the "comparable" product. These made-for-outlet products may be manufactured in a different place, with different materials, or according to different specifications (i.e. different stitch pattern, seam reinforcement, button quality, etc.) AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem Conditionally AddItem ReviseItem RelistItem VerifyAddItem Conditionally GetItem Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally Details of a flat or calculated shipping discount profile. The unique eBay-created ID for the shipping discount, assigned when the profile is created. On input, if ModifyActionCode is Add, this is ignored if provided. If ModifyActionCode is Modify, all details of the new version of the profile must be provided. If ModifyActionCode is Delete, DiscountProfileID is required, MappingDiscountProfileID is optional, and all other fields of DiscountProfile are ignored. GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The user's title for this profile. On input, if ModifyActionCode is Add, this is ignored (if provided) if this is the first profile being created and required if there is more than one profile of that type (flat rate versus calculated) already. To modify the name, set ModifyActionCode to Update and provide all details for the profile. On output, DiscountProfileName is only returned if the user defined more than one profile. GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The amount, if the seller specified EachAdditionalAmount as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only. GetShippingDiscountProfiles FlatShippingDiscount Conditionally SetShippingDiscountProfiles FlatShippingDiscount Conditionally GetItem GetSellingManagerTemplates FlatShippingDiscount InternationalFlatShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The amount, if the seller specified EachAdditionalAmountOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only. GetShippingDiscountProfiles FlatShippingDiscount Conditionally SetShippingDiscountProfiles FlatShippingDiscount Conditionally GetItem GetSellingManagerTemplates FlatShippingDiscount InternationalFlatShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The percent (expressed in decimal, as in .5 for 50%), if the seller specified EachAdditionalPercentOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only. GetShippingDiscountProfiles FlatShippingDiscount Conditionally SetShippingDiscountProfiles FlatShippingDiscount Conditionally GetItem GetSellingManagerTemplates FlatShippingDiscount InternationalFlatShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The weight by which to reduce the combined item weight, if the seller specified WeightOff as the type of profile, as noted in CalculatedShippingDiscount.DiscountName. The smallest unit is used (e.g. ounces). Calculated shipping only. GetShippingDiscountProfiles CalculatedShippingDiscount Conditionally SetShippingDiscountProfiles CalculatedShippingDiscount Conditionally GetItem GetSellingManagerTemplates CalculatedShippingDiscount InternationalCalculatedShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally For SetShippingDiscountProfiles, if MappedDiscountProfileID is omitted when ModifyActionCode is Delete, any listings currently using the profile identified by DiscountProfileID will have that profile removed. For SetShippingDiscountProfiles and GetItem, this is the intended discount profile mapping. GetShippingDiscountProfiles CalculatedShippingDiscount Conditionally SetShippingDiscountProfiles CalculatedShippingDiscount Conditionally GetItem GetSellingManagerTemplates CalculatedShippingDiscount InternationalCalculatedShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The nature of the discount. An offer that applies to a limited number of listings during the offering period. Example: "There is no insertion fee for up to 5 auctions when listing between 12/1 and 12/10." An offer that applies to an unlimited number of listings during the offering period. Example: "Get subtitle for $0.10 in Tech category when listing between 12/25 and 12/28. No limit to the number of items listed during this period." Reserved for future use This type is deprecated as the <b>GetProduct*</b> calls are no longer available. The measurement used in a proximity search distance calculation. The unit used in a proximity search distance calculation. PictureManagerLevel1, PictureManagerLevel2, PictureManagerLevel3, PictureManagerLevel4, PictureManagerLevel5, PictureManagerLevel6, PictureManagerLevel7 Allowed categories are Motorcycles, Powersports, and Other Vehicles. In addition to the categories allowed by LocalMarketSpecialty, allows Passenger Vehicles. Includes five sub-types. See LocalMarketRegularSubscriptionDefinitionType for details. Allows same categories as LocalMarketRegular. The status of a particular entry. The entry is enabled. The entry is disabled. Reserved for future use. Specifies the seller's reason for ending an item listing early. This is required if the seller ends a listing early. This can be on an item that hasn't sold and has no bids or on an item that has bids and the seller wants to sell the item to the high bidder now. The item was lost or broken. The item is no longer available for sale. The start price or reserve price is incorrect. The listing contained an error (other than start price or reserve price). Reserved for internal or future use. Seller want to sell the listing to the high bidder. A seller can end a listing in order to seller to the current high bidder when the listing has qualifying bids (i.e., there is a current high bid that, when applicable, meets the minimum reserve price) and there is more than 12 hours before the listing ends. <br> Note: In the last 12 hours of an item listing, you cannot end an item early if it has bids. The vehicle was sold. Applies to local classified listings for vehicles only. This type is deprecated as the eBay Express is no longer available. If false, indicates that an item is not Express-eligible because the seller is not Express-eligible. Only returned if false, and no other settings are returned in this case. If true, this field indicates the item was opted out of Express; that is, ExpressOptOut was true in the listing request. Only returned if true, and no other settings are returned in this case. If true, indicates eBay has marked the item as eligible for eBay Express based on direct evaluation. Only returned if true, and no other settings are returned in this case. If true, indicates the item listing format is eligible for Express. If false, the listing format is ineligible (and the item is therefore ineligible). If true, the item's primary category is enabled for Express. If false, the primary category is not enabled for Express (and the item is therefore ineligible). If true, the seller has an Express-eligible PayPal account. If true, domestic shipping costs are specified for the item. If false, they aren't specified (and the item is therefore ineligible). If true, the item is covered by a return policy that meets the site's requirements for Express. Only returned for Express Germany. (A return policy is optional for Express US.) If true, the item includes a picture. If false, the item doesn't include a picture. Only returned if the category requires a picture for Express. Some categories waive the picture requirement. If true, the item specifies an eligible item condition. If false, the item doesn't specify an eligible item condition. Only returned if the category requires an item condition for Express. Some categories waive the item condition requirement. If true, the price of the item is above the minimum price allowed on Express. That is, the StartPrice, BuyItNowPrice, or CurrentPrice is above the minimum.) If true, the price of the item is below the maximum price allowed on Express. (That is, the StartPrice, BuyItNowPrice, or CurrentPrice is below the maximum.) If true, indicates the item meets the site's eBay Express requirements for checkout. (A common case when this could be false would be when ThirdPartyCheckout is true but ThirdPartyCheckoutIntegration is false.) If true, the item has no pre-approved bidder list. If true, the item is not an eBay Giving Works item. Only returned if the site does not allow charity listings on Express. (In other words, if the site excludes charity listings from Express, then NoCharity=true means the item meets the eligibility requirement.) If true, the item offers a combined shipping discount. Only returned if the Express site has an item-level combined shipping discount requirement. (Some Express sites only require you to accept combined payments at the seller level, in your My eBay preferences.) If true, the country you specified for the item meets the specified site's shipping origin requirements for Express. If true, the PayPal account for the item accepts payments from a buyer with an unconfirmed address. If false, the account blocks unconfirmed addresses (and the item is therefore ineligible). Contains extended contact information for an eBay user. All fields related to contact hours including time ranges and user-designated time zone. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Returned for classified ads to indicate whether contact by email is enabled. In the pay-per-lead feature, which will be available in upcoming months on the US site, this field will specify whether potential buyers can email the seller after viewing a pay-per-lead listing. AddItem AddItems AddSellingManagerTemplate ReviseItem ReviseSellingManagerTemplate VerifyAddItem RelistItem VerifyRelistItem No GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 The pay-per-lead feature is no longer available, and this field is scheduled to be removed from the WSDL. This type is deprecated as the call is no longer available. A product finder ID. GetCategory2CS always (and only) returns this when Category.ProductFinderIDs is returned. GetCategory2CS
DetailLevel: ReturnAll
Conditionally MappedCategoryArray If false or not present, the product finder can be used as input to GetProductSearchResults to search for catalog data (Pre-filled Item Information) that a seller might want to include in a listing. GetCategory2CS
DetailLevel: ReturnAll
Conditionally MappedCategoryArray Knowledge Base: ProductFinderID for Buy-Side Searches https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=560 This type is deprecated as the partent of this type is no longer available. ExternalProductID.Value contains an ISBN value. Required when you pass an ISBN as the external product ID. (This value is also applicable to Half.com listings.) ExternalProductID.Value contains a UPC value. Required when you pass a UPC as the external product ID. (This value is also applicable to Half.com listings.) ExternalProductID.Value contains an eBay catalog product ID. Required when you pass an eBay product ID as the external product ID. ExternalProductID.Value contains an EAN value. Required when you pass an EAN as the external product ID. ExternalProductID.Value contains a set of keywords that uniquely identify the product. Only applicable when listing event ticket. See the eBay Web Services guide for information about valid ticket keywords for an external product ID. Required when you pass a set of keywords as the external product ID. Reserved for future use. Reserved for internal or future use This type is deprecated as the partent of this type is no longer available. An industry-standard value that uniquely identifies the product. The valid values are dictated by the Type property. Required if Type is specified. Max length 13 for ISBN (as of February 2007), 13 for EAN, 12 for UPC, and 4000 for ProductID. No max length for ticket keywords (but passing too much data can result in "no match found" errors).<br> <br> <b>For AddItem and related calls:</b> If the primary and secondary categories are both catalog-enabled, the value must apply to the primary category. Event tickets listings support a set of keywords that uniquely identify the listing. The ticket keywords specify the event name (the title shown on the ticket), venue name, and event date and time. See the eBay Web Services guide for more information and validation rules. For convenience, you can pass an eBay product ID as input (not limited to media categories).<br> <br> Required for Half.com listing use cases, and this can only be an ISBN, UPC, or EAN value.<br> <br> <b>For GetSellerPayments output only:</b> Also see AlternateValue, which is returned if the catalog defines multiple ISBN values (e.g., one for ISBN-13 and one for ISBN-10). Please note that some catalogs return ISBN values that are not 10 or 13 characters, and some values contain non-alphanumeric symbols (e.g., $). Applicable for listing use cases only (not buy-side searching). Indicates what eBay should do if more than one product matches the value passed in Value. Only takes effect when more than one match is found. If true, the response should include an error and all matching product IDs. If false, the response should include an error but should not return the matching product IDs. This field is also applicable when listing Half.com items. The kind of identifier being used. The choices are listed For requests, required if Value is specified. For Half.com listing use cases, only ISBN, UPC, and EAN are supported. An industry-standard value that provides an alternate identification for the product, if any. Currently, this only returns an alternate ISBN value. If the catalog defines both an ISBN-13 and ISBN-10, then the ISBN-13 is returned in Value and the ISBN-10 is returned in AlternateValue. (That is, the ISBN-13 is considered to be the preferred identifier.) If the catalog only defines one ISBN, it is returned in Value (and AlternateValue is not returned). Please note that some catalogs return ISBN values that are not 10 or 13 characters, and some values contain non-alphanumeric symbols (e.g., $). Container consisting of details related to payment of an eBay order on an external system such as PayPal. This container is only returned if payment has been made on an order. For GetSellerTransaactions and GetItemTransactions, this container is not returned for multiple line item orders. Unique identifier for a PayPal payment of an eBay order. If the order was purchased with a payment method other than PayPal, "SIS" is returned, which stands for "Send Information To Seller." This field is only returned after payment has been made. ReviseCheckoutStatus Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Conditionally GetOrders
DetailLevel: ReturnAll
Conditionally SoldReport Always Timestamp for payment transaction. ReviseCheckoutStatus Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Conditionally GetOrders
DetailLevel: ReturnAll
Conditionally GetOrderTransactions
DetailLevel: ReturnAll
Conditionally SoldReport Always Fee Amount is a positive value and Credit Amount is a negative value. GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Conditionally GetOrders
DetailLevel: ReturnAll
Conditionally GetOrderTransactions
DetailLevel: ReturnAll
Conditionally SoldReport Always If positive, the amount the buyer pays the seller through PayPal on the purchase of items. If negative, the amount refunded the buyer. Default = 0. GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Conditionally GetOrders
DetailLevel: ReturnAll
Conditionally GetOrderTransactions
DetailLevel: ReturnAll
Conditionally SoldReport Always Indicates whether the seller making the request can list with certain features. A seller's eligibility is determined by their feedback rating. Indicates whether the seller is eligible to list items with the 'BuyItNow' option. A value of true means that the seller is eligible; a value of false indicates that they are not eligible. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Indicates whether the seller is eligible to specify the 'BuyItNow' option for multiple-item listings. A value of true means that the seller is eligible; a value of false indicates that they are not eligible. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Indicates whether the seller is eligible to list a fixed-price item with a one-day listing duration. A value of true means that the seller is eligible; a value of false indicates that the seller is not eligible. Note that this field only controls user eligibility. The listing type and category must support this feature for this field to be applicable. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Indicates whether or not the seller is eligible to list multi-variation items. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Always Indicates whether the seller is eligible to list an auction item with a one day duration on this site. Limitation: the Adult-Only and Auto Vehicle categories do not support one day auctions, so the seller cannot list items in these categories as one day auctions even if the seller has the eligibility. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Identifies the name and cost of a listing feature that a member pays to eBay (or an eBay company). These listing feature names, fees, and possible discounts are intended only as an aid to help estimate the fees for a listing. Use GetAccount for an accurate final fee breakdown. Returned in AddItemResponseType and related response types. Name of the listing feature, for identification purposes. See the Trading API guide for a list of current listing features names and associated fees. ListingFees UseTopicAlias AddFixedPriceItem AddItem AddItems AddLiveAuctionItem RelistFixedPriceItem RelistItem ReviseInventoryStatus ReviseFixedPriceItem ReviseItem ReviseLiveAuctionItem VerifyAddFixedPriceItem VerifyAddItem VerifyRelistItem Always Amount of the fee that eBay will charge the member for the associated listing feature. See the eBay.com Web site online help for a current schedule of listing features and their associated fees. eBay.com Fees http://pages.ebay.com/help/sell/fees.html AddFixedPriceItem AddItem AddItems AddLiveAuctionItem RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseInventoryStatus ReviseItem ReviseLiveAuctionItem VerifyAddFixedPriceItem VerifyAddItem VerifyRelistItem Always This field exists in the response when the user has selected the features that participate in a promotional discount. See the eBay.com Web site online help for a current fee schedule. eBay.com Fees http://pages.ebay.com/help/sell/fees.html AddFixedPriceItem AddItem AddItems AddLiveAuctionItem RelistFixedPriceItem ReviseInventoryStatus RelistItem ReviseFixedPriceItem ReviseItem ReviseLiveAuctionItem VerifyAddFixedPriceItem VerifyAddItem VerifyRelistItem Always The color of a feedback score star visually denotes the range in which the member's summary feedback score falls. The score is the net positive feedback minus the net negative feedback left for the member. No graphic displayed, feedback score 0-9. Yellow Star, feedback score 10-49. Blue Star, feedback score 50-99. Turquoise Star, feedback score 100-499. Purple Star, feedback score 500-999. Red Star, feedback score 1,000-4,999 Green Star, feedback score 5,000-9,999. Yellow Shooting Star, feedback score 10,000-24,999. Turquoise Shooting Star, feedback score 25,000-49,999. Purple Shooting Star, feedback score 50,000-99,999. Red Shooting Star, feedback score 100,000-499,999. Green Shooting Star, feedback score 500,000-999,999. Silver Shooting Star, feedback score 1,000,000 and above. Reserved for internal or future use. Used to determine whether the seller meets the minimum feedback requirements for Express. 587 NoOp GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetUser
DetailLevel: none, ReturnAll
Conditionally Identifies a set of one or more fees that a member pays to eBay (or an eBay company). Instances of this type can hold one or more fees. Contains the name, fee, and possible discount amount for an item listing feature. A Fee container is returned for each listing feature, even if the associated cost (Fee value) is 0. AddFixedPriceItem AddItem AddItems AddLiveAuctionItem RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseLiveAuctionItem VerifyAddFixedPriceItem VerifyAddItem ReviseInventoryStatus VerifyRelistItem Always AddItemFromSellingManagerTemplate AddSellingManagerTemplate GetSellingManagerTemplateAutomationRule GetSellingManagerItemAutomationRule SetSellingManagerTemplateAutomationRule SetSellingManagerItemAutomationRule GetSellingManagerTemplateAutomationRule DeleteSellingManagerItemAutomationRule DeleteSellingManagerTemplateAutomationRule ReviseSellingManagerTemplate Conditionally Details of an individual discount profile defined by the user for flat rate shipping. The type of discount or "rule" that is being used by the profile. The value corresponding to the selected rule is set in the same-named field of FlatShippingDiscount.DiscountProfile. All are "variable" rules, as defined in the documentation on shipping discount profiles. GetShippingDiscountProfiles EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff Conditionally SetShippingDiscountProfiles EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff Conditionally GetItem GetSellingManagerTemplates EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally UseTopicAlias ShippingDiscountProfiles Details of this particular flat rate shipping discount profile. If ModifyActionCode is Modify, all details of the new version of the profile must be provided. If ModifyActionCode is Delete, DiscountProfileID is required, MappingDiscountProfileID is optional, and all other fields of DiscountProfile are ignored. Restrictions of how many profiles you can have for a given discount rule are discussed in the documentation on shipping discount profiles. GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally UseTopicAlias ShippingDiscountProfiles The status of gallery image generation. That status will return either a value of 'Success' or a value that indicates why the gallery image has not been generated. Gallery Image successfully generated. Gallery image has not yet been generated. The URL for the image is not valid. URL does not start with http:// - That is the only protocol currently supported for pictures. There is a problem with the file containing the image. The server containing your image was unavailable when we tried to retrieve it. We could not find your Gallery image when we went to retrieve it. The image failed to come across the Internet when we tried to retrieve it. The file containing your image is not in standard jpeg, bmp, or tif format. We were not able to process the image. Reserved for internal or future use. Indicates whether listing images are included in the search results (in both Picture Gallery and List Views) and, if so, which image listing enhancements apply to them. Items that have pictures but do not have image listing enhancements display a generic photo image in search results. Listing image is not included in the search results (in either Picture Gallery or List Views), and no other image listing enhancements apply. Items that have pictures but do not have image listing enhancements display a generic photo image in search results. <br><br> Mainly useful for RelistItem use cases when you want to remove an existing gallery setting. However, not all image listing enhancements can be removed on revise or relist. <br><br> Note that specifying None is not necessarily the same as omitting GalleryType from a request. For example, specifying other item properties may cause the listing to be included in the search results Gallery by default if GalleryType is not specified. Highlights the listing at the top of the search results. (No longer available for the US site; also, no longer available on the US eBay Motors site, in the Parts and Accessories category. In these cases, listings containing Featured First are listed, but Featured First is dropped and a warning is returned.) <br><br> Additionally, the listing gets the Gallery and Gallery Plus functionality. Note that "Gallery" and "Plus" do not need to be specified separately in a listing. Passing "Featured", "Plus", and "Gallery" in the same request causes an error. <br><br> For the eBay Motors site (site ID 100), passing "Featured" may put certain items on the eBay Motors home page. <span class="tablenote"><b>Note:</b> "Gallery Featured" was replaced by "Featured First" on several eBay sites, including UK, IE, DE, AT, CH, and IT. </span> <br><br> Listing image is included in the search results (in both Picture Gallery and List Views). Items that have pictures but do not have the Gallery feature will have a generic photo image shown in search results. <br><br> Some listing enhancements (for example, "Featured" and "Plus") automatically include the Gallery functionality, so "Gallery" does not need to be specified separately in the listing. Passing "Featured", "Plus", and "Gallery" in the same request will return an error. Listing image has Gallery Plus funtionality. That is, listing includes a Gallery Plus icon that, when moused over or clicked, displays a large (400 px x 400 px) preview image of the item. Clicking the image displays the View Item page for that listing. <br><br> Listing images that are originally smaller than 400 px x 400 px are centered in the preview frame. Images that are originally larger than 400 px x 400 px are scaled down to 400 px on their longest side (maintaining their original aspect ratio). <br><br> Note that you can use the Gallery Plus feature whether or not the image is hosted with eBay Picture Services (EPS). One EPS image is included at no cost with the Gallery Plus feature. <br><br> When "Plus" is included in an item listing, the listing also automatically gets the Gallery functionality at no extra cost. "Gallery" does not need to be specified separately in the listing. Passing "Featured", "Plus", and "Gallery" in the same request will return an error. <br><br> <span class="tablenote"><b>Note:</b> The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). <br><br> On these sites (starting on the same production date), whenever Plus is selected in a request that specifies at least two eBay Picture Services (EPS) hosted images (using ItemType.PictureDetailsType.PictureURL), the Gallery Plus feature now automatically includes a Gallery Showcase of all the listing's images at no extra cost. If Plus is selected and the request includes only one EPS image or any self-hosted images, regular Gallery Plus applies. <br><br> The Gallery Showcase displays when mousing over or clicking on the listing's Gallery Plus icon in the search results. The Showcase window displays a large (400 px x 400 px) preview image which is usually the first specified PictureURL, as well as up to four (64 px x 64 px) selectable thumbnails for the remaining EPS images (the Showcase window contains pagination controls for observing all EPS images in the request). Clicking on the preview image displays the item's listing page. <br><br> When using RelistItem or ReviseItem (item has no bids and more than 12 hours before the listing's end), Plus can be unselected in the request. However, the Plus fee will still apply if a previous request selected Plus. There is at most one Plus fee per listing. </span> <br><br> Not applicable to eBay Stores Inventory listings. Reserved for internal or future use. Each code identifies an optional service that the seller is offering if the buyer chooses to purchase the item as a gift. Not applicable for eBay Store Inventory listings. The seller is offering to ship the item via an express shipping method as explained in the item description. The seller is offering to ship to the gift recipient (instead of to the buyer) after payment clears. The seller is offering to wrap the item (and optionally include a card) as explained in the item description. Reserved for internal or future use HitCounterCodeType - Type declaration to be used by other schema. Indicates whether a hit counter is used for the item's listing page and, if so, what type. No hit counter. The number of page views will not be available. A basic style hit counter (US only). Non-US sites will return errors if they use HonestyStyle as input, and should use BasicStyle instead. US A green LED, computer-style hit counter (US only). Non-US sites will return errors if they use GreenLED as input, and should use RetroStyle instead. US A hidden hit counter (US only). The number of page views will only be available to the item's seller. For faster "View Item" page loads, use HiddenStyle. US A basic style hit counter. A retro, computer-style hit counter. A hidden hit counter. The number of page views will only be available to the item's seller. Reserved for internal or future use Contains the cost of shipping insurance and other insurance-related information. Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. <br><br> Valid only on the following sites: AU, FR, and IT <br /> Applicable to Half.com (for GetOrders). AddFixedPriceItem AddItem AddItems AddOrder AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerSaleRecord ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetOrders
DetailLevel: none, ReturnAll
OrderArray.Order Always GetOrderTransactions OrderArray.Order
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetSellingManagerSaleRecord Always Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Applies to both flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true. <br><br> Valid only on the following sites: AU, FR, and IT <br /> Applicable to Half.com (for GetOrders). AddFixedPriceItem AddItem AddItems AddOrder AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerSaleRecord ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem NotOfferedOnSite No GetBidderList GetItemShipping GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetOrders OrderArray.Order
DetailLevel: none, ReturnAll
Always GetOrderTransactions OrderArray.Order
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetSellingManagerSaleRecord Always The seller's requirements regarding whether the buyer pays for shipping insurance. The seller offers the buyer the choice of paying for shipping insurance or not. The seller requires that the buyer pay for shipping insurance. The seller does not offer shipping insurance to the buyer. The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. Reserved for internal or future use Indicates the sites on which a seller is eligible to offer IMCC as a payment method. Indicates a site on which a seller has a payment gateway account (and thus a site on which the seller can use the IntegratedMerchantCreditCard payment method). GetUser Conditionally Container consisting of shipping costs and other details related to an international shipping service. If one or more international shipping services are provided, the seller must specify at least one domestic shipping service as well. An international shipping service being offered by the seller to ship an item to a buyer. For a list of valid values, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ShippingServiceDetails</b>. To view the full list of International shipping service options in the response, look for the ShippingService fields in the ShippingServiceDetails containers that contain a InternationalService=true field, as this indicates that the ShippingService value is an International shipping service option. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. <br><br> For flat and calculated shipping. ShippingServiceCodeType SendInvoice No AddFixedPriceItem AddItem AddItems AddOrder AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetOrders
DetailLevel: none, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally UseTopicAlias GeteBayDetails The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. <br> <br> If a shipping service has been specified, GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. SendInvoice No AddFixedPriceItem AddItem AddItems AddOrder AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetOrders
DetailLevel: none, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally UseTopicAlias Shipping The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only. SendInvoice No AddFixedPriceItem AddItem AddItems AddOrder AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetOrders
DetailLevel: none, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to five international shipping services (with five InternationalShippingServiceOption containers), so valid values are 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 5 appears at the bottom of a list of five shipping service options. <br><br> This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings. SendInvoice No AddFixedPriceItem AddItem AddItems AddOrder AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetOrders
DetailLevel: none, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally An international location or region to where the item seller will ship the item. Use <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ShippingLocationDetails</b> to determine which locations are valid per site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields. For the AddItem family of calls, this field is required if any international shipping service is specified. ShippingRegionCodeType, CountryCodeType SendInvoice No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetOrders
DetailLevel: none, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally AddFixedPriceItem AddItem AddItems AddOrder AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddFixedPriceItem VerifyAddItem VerifyRelistItem Conditionally UseTopicAlias ShipToLocation The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. <br><br> Valid only on the following sites: AU, FR, and IT <br> Also applicable to Half.com (for GetOrders). GetItemShipping Conditionally GetOrders
DetailLevel: none, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally AddOrder SendInvoice No GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally UseTopicAlias Shipping The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. 0 GetItemShipping Conditionally GetOrders
DetailLevel: none, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally This is used in ReviseInventoryStatus response to provide the set of fees associated with each unique ItemID.. The ItemID of the listing being changed. <br> <br> The ReviseInventoryStatus response includes a separate set of fees for each item that was successfully revised.<br> <br> Use the ItemID to correlate the Fees data with the InventoryStatus data in the response. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) ReviseInventoryStatus Always Contains the data for one fee (such as name and amount). ReviseInventoryStatus Always Lightweight type for updating basic inventory status details. Primarily intended for bulk use cases. The unique SKU of the item being revised. A SKU (stock keeping unit) is an identifier defined by a seller. SKU can only be used to revise an item if you listed the item by using AddFixedPriceItem or RelistFixedPriceItem, and:<br> 1) You set Item.InventoryTrackingMethod to SKU at the time the item was listed; or <br> 2) You are modifying a multi-variation listing, and the SKU identifies one of the variations. (In this case, if InventoryTrackingMethod was set to ItemID, then you also need to specify ItemID in the request.)<br> (These criteria are necessary to uniquely identify the listing or variation by a SKU.)<br> <br> In the ReviseInventoryStatus request, if the listing has InventoryTrackingMethod set to SKU, then either ItemID or SKU is required. If both are passed in and they don't refer to the same listing, eBay ignores SKU and considers only the ItemID.<br> <br> If the listing has variations and InventoryTrackingMethod is set to ItemID, then ItemID and SKU are both required.<br> <br> In the response, SKU may be returned as an empty element if it was not defined on the listing. ReviseInventoryStatus Conditionally ReviseInventoryStatus Always The ItemID of a listing being changed. <br> <br> In the ReviseInventoryStatus request, either ItemID or SKU is required. If both are passed in and the SKU does not match, eBay ignores SKU and considers only the ItemID.<br> <br> Please note that the same ItemID can be returned multiple times in the same response if you revise several variations from the same multi-variation listing. ReviseInventoryStatus Conditionally ReviseInventoryStatus Always Specifies the revised fixed price of the listing (or of a variation within a multi-variation listing). If you raise the price of a listing, the recent sales score of the listing is reset. (Best Match search ranking is based on buyer activity, and one of the factors affecting search ranking for fixed-price listings is the recent sales score.)<br> <br> Raising a listing's price may also affect the insertion fee (and therefore the overall listing fee).<br> <br> ReviseInventoryStatus requires either StartPrice or Quantity (or both) for each InventoryStatus node in the request. Insertion Fees http://pages.ebay.com/help/sell/insertion-fee.html eBay.com Listing Fees http://pages.ebay.com/help/sell/fees.html ReviseInventoryStatus Conditionally ReviseInventoryStatus Always Specifies the latest quantity of the listing (or of a variation within a multi-variation listing).<br> <br> <b>For the ReviseInventoryStatus request:</b> Specify the entire quantity that is currently available for sale. (Typically, you only pass this in when you need to update the quantity.)<br> <br> ReviseInventoryStatus requires either StartPrice or Quantity (or you can specify both) for each InventoryStatus node in the request.<br> <br> <b>For the ReviseInventoryStatus response:</b> This returns a total of the quantity available for sale plus the quantity already sold. For example, suppose the listing originally had Quantity=10, and then 8 sold. Now you restock your inventory, and you pass Quantity=10 in the ReviseInventoryStatus request. In this case, ReviseInventoryStatus returns Quantity=18 (10 available + 8 sold). To determine the quantity available, use GetItem or GetSellerList, and subtract SellingStatus.QuantitySold from Quantity. Or see QuantityAvailable in GetMyeBaySelling.<br> <br> It is a good idea to maintain an adequate quantity available for fixed-price GTC listings to prevent the search rankings from dropping. Best Match search ranking is based on buyer activity, and one of the factors affecting search ranking for fixed-price listings is the recent sales score. Fixed-price items that are selling the fastest are given a relative lift in search results. Recent Sales history is tracked with a moving window to ensure it reflects the most recent activity. Due to he moving window, it is advantageous to maintain item availability (Quantity-QuantitySold) for a GTC listing. ReviseInventoryStatus Conditionally ReviseInventoryStatus Always Defines options to track a listing by the eBay item ID or the seller's SKU. In some calls, elements of this type are only returned in the response when the value is set to SKU on the item. The seller prefers to track the listing by its eBay item ID. This is the default for all listings. The seller prefers to track the listing by their own SKU. When you track by SKU, it means you can pass your SKU instead of the eBay item ID in other calls that support SKU as an input field. If you choose SKU as your tracking preference for a listing, the value in Item.SKU must be unique across your active listings. You cannot create new listings with the same Item.SKU value while the listing is active (that is, until the existing listing with that SKU has ended). However, you can use ReviseInventoryStatus to update the quantity and/or price for the existing SKU as needed. When revising a listing where the InventoryTrackingMethod was set to SKU, you must pass in both the InventoryTrackingMethod tag (with the value set to SKU) and the SKU tag with the SKU value from your original listing. Reserved for internal or future use Contains bidding details information of a user on an item. The unique identifier of an item listed on the eBay site. For GetAllBidders, an anonymous user ID is returned. <br><br> Since a bidder's user info is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules: <br><br> When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". <br> Note that in this format, the anonymous bidder ID stays the same for every auction. <br><br> (GetMyeBayBuying only) when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. <br><br> When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. <br> Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". <br><br> (GetMyeBayBuying only) when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". <br><br> (GetBestOffers only) - all sites: The last part of the user ID is replaced with asterisks for users that submit best offers on an item. The seller of the item will be able to see the full UserID. UseTopicAlias AnonymousUserInfo GetAllBidders Conditionally Numeric ID for the category that the item belongs to. GetAllBidders Conditionally The total number of bids the user placed on the item. GetAllBidders Conditionally The eBay ID of the seller who listed the item. <br><br> Starting Jan 2007, when a bidder's user info is made anonymous, this tag will be returned with the anonymous value "Seller X", where X indicates where the seller falls in the sequence of sellers that the user has purchased items from. For example, if the seller is the third seller that the user has purchased items from, the value "Seller 3" is returned. UseTopicAlias AnonymousUserInfo GetAllBidders Conditionally The time at which the user placed the last bid on the item. GetAllBidders Conditionally A list of compatible applications 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 would map to standard vehicle characteristics (e.g., Year, Make, Model, Trim, and Engine). The values would desribe the specific vehicle, such as a 2006 Honda Accord. Details for an individual compatible application, consisting of the name-value pair and related compatibility notes. When revising or relisting, the <b class="con">Delete</b> field can be used to delete individual compatibility nodes. AddFixedPriceItem AddItem AddItemFromSellingManagerTemplate AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddFixedPriceItem VerifyAddItem VerifyRelistItem Conditionally GetItem Conditionally Set this value to true to delete or replace all existing parts compatibility information when you revise or relist an item. If set to true, all existing item compatibility nodes are removed from the listing. If new item compatibilities are specified in the request, they replace the removed compatibilities. <br/><br/> <span class="tablenote"> <strong>Note:</strong> To ensure that buyer expectations are upheld, you cannot delete or replace an item compatibility list if the listing has bids or if the auction ends within 12 hours. </span> false RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem Conditionally All information corresponding to an individual compatibility by application. Removes individual parts compatibility nodes from the compatibility list. Set to true within the compatibility to delete. <br><br> This field can only be used when revising an item or template. <br> If the listing has bids or ends within 12 hours, you cannot delete item compatibilities. false ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate Conditionally A name-value pair describing a single compatible application. The allowed names and values are specific to the primary category in which the item is listed. For example, when listing in a Parts & Accessories category, where the applications are vehicles, the allowed names might include Year, Make, and Model, and the values would correspond to specific vehicles in eBay's catalog. <br><br> The K type vehicle number is supported in the DE, UK, and AU eBay sites to specify parts compatibility. To use a K type number to specify item compatiblities, set the Name field to "KType" and set the corresponding Value field to the K type number. AddFixedPriceItem AddItem AddItemFromSellingManagerTemplate AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally Product Metadata API Call Reference http://developer.ebay.com/DevZone/product-metadata/CallRef/index.html information on retrieving compatibility search names and corresponding values needed to specify compatibility by application manually GetItem Conditionally The seller may optionally enter any notes pertaining to the compatibility being specified. Use this field to specify the placement of the part on a vehicle or the type of vehicle a part fits. AddFixedPriceItem AddItem AddItemFromSellingManagerTemplate AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetItem Conditionally Type that represents the unique identifier for a single item listing. Specifies the details of policy violations if the item was administratively canceled. The details are the policy ID and the policy text. Policy ID of the violated policy which resulted in item being administratively canceled. GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally Brief information of the violated policy which resulted in item being administratively canceled. GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally Defines the system source for an Item Specific. The Item Specific was originally stored with custom Item Specifics fields. (For example, the seller used the ItemSpecifics node in AddItem.) This is the default setting if Source isn't returned. The Item Specific was originally stored with eBay's system-defined (ID-based) attributes format. (For example, the seller used the AttributeSetArray node in AddItem at a time when the category supported Attributes.) The Item Specific is prefilled from a product catalog. (For example, the seller used ExternalProductID or ProductID in AddItem.) Reserved for future use. This container is designed to return all order line items related to specific multiple-item, fixed-price listings. Additionally, a SKU filter can be used to return all order line items related to a specific product or variation of an item. Unique identifier for an eBay item listing. A listing can have multiple order line items (transactions), but only one <b>ItemID</b>. Unless an <b>OrderLineItemID</b> or <b>SKU</b> value is specified in the same node, this field is required for each <b>ItemTransactionID</b> node included in the request. 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) GetOrderTransactions Conditionally Unique identifier for an eBay order line item (transaction). The <b>TransactionID</b> should match the <b>ItemID</b> specified in each <b>ItemTransactionID</b> node included in the request. Optionally, an <b>OrderLineItemID</b> value can substitute for the <b>ItemID</b>/<b>TransactionID</b> pair. 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) GetOrderTransactions Conditionally A SKU (stock keeping unit) is a unique identifier defined and used by the seller to identify a product or variation of an item. A listing can have multiple SKUs and it is possible that the same SKU can exist in multiple listings. Unless an <b>OrderLineItemID</b> or <b>ItemID</b>/<b>TransactionID</b> pair is specified in the same node, this field is required for each <b>ItemTransactionID</b> node included in the request. To retrieve order line items associated with a SKU, the <b>InventoryTrackingMethod</b> field must be set to SKU. The <b>InventoryTrackingMethod</b> field is set through <b>AddFixedPriceItem</b> or <b>RelistFixedPriceItem</b>. 50 GetOrderTransactions Conditionally <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. If an <b>OrderLineItemID</b> is included in a <b>ItemTransactionID</b> node in the request, the <b>ItemID</b>, <b>TransactionID</b>, and <b>SKU</b> fields are not required and are ignored if they are included in the request. <br> 50 (Note: The eBay database specifies 38. ItemIDs and TransactionIDs are usually 9 to 12 digits.) GetOrderTransactions Conditionally Contains the data defining one item. A seller populates an object of this type at listing time with the definition of a new item. A seller also uses an object of this type to relist or revise an item. Calls that retrieve item data (such as the GetSellerList call) return an object of this type, filled with the item's data. Some fields are applicable both to eBay listings and Half.com listings. Some fields are only applicable to eBay listings, and others are only applicable to Half.com listings. Returns custom, application-specific data associated with the item. The data you specify is stored by eBay with the item for your own reference, but it is not used by eBay in any way. Use ApplicationData to store special information for yourself, such as a part number. For a SKU in an eBay.com listing, use the SKU element instead. To remove this value when revising or relisting an item, use DeletedField. <br> <br> Not applicable to Half.com, use SellerInventoryID instead. 32 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally half No longer applicable to any categories. 773 NoOp 889 Item.ItemSpecifics AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem VerifyAddItem VerifyRelistItem Conditionally GetItemRecommendations RelistItem ReviseItem ReviseFixedPriceItem ReviseSellingManagerTemplate VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally GetSellingManagerInventory ReviseSellingManagerTemplate No This container is used to specify one or more item attributes for a Half.com listing. This container is not applicable for eBay fixed-price or auction listings. <br><br> You can use <b>ReviseItem</b> to modify attribute values for Half.com listings. <br><br> Half.com listing attributes are not returned in <b>GetItem</b>. AddItem AddItems VerifyAddItem Conditionally ReviseItem No GetOrders
DetailLevel: none, ReturnAll
Always HalfOverview UseTopicAlias No longer applicable to any category. Use ConditionID instead. 773 Avoid 889 Item.ConditionID AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem VerifyAddItem VerifyRelistItem No To create a requirement that a buyer pays immediately (through PayPal) for an auction (Buy It Now only) or fixed-price item, the seller can include and set the <b>AutoPay</b> field to 'true' for an Add/Revise/Relist/VerifyAdd API call. If the seller does not want to create an immediate payment item, this field is either omitted, or included and set to 'false'. <br> <br> If this feature is enabled for a listing, the buyer must pay immediately for the item through PayPal, and the buyer's funds are transferred instantly to the seller's PayPal account. The seller's item will remain available for purchase by other buyers until the buyer actually completes the payment. <br> <br> In order for a seller to apply an immediate payment requirement for an item, the following must be true: <ul> <li>seller must have a Premier or Business PayPal account;</li> <li>the Buy It Now price (if applicable) cannot be higher than $10,000 USD;</li> <li>the listing site supports PayPal payments;</li> <li>the category supports PayPal payments;</li> <li>the listing type is fixed-price or auction (with Buy It Now option).</li> </ul> <br> To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call: <ul> <li>seller must provide a valid <b>Item.PayPalEmailAddress</b> value;</li> <li>seller must offer PayPal as the only payment method;</li> <li>seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges;</li> <li>seller must include and set the <b>PromotionalShippingDiscount</b> field to true if a promotional shipping discount is being applied to the listing;</li> <li>seller must include the <b>ShippingDiscountProfileID</b> and reference a valid flat or calculated Shipping Discount Profile ID if a flat or calculated shipping rule is being applied to the listing.</li> </ul> <br> In the Trading API calls that return the <b>AutoPay</b> field, be aware that the field's appearance in the output does not necessarily indicate that the immediate payment feature was successfully enabled/used for the active or ended listing, but only that the seller attempted to enable (by including and setting <b>AutoPay</b> to 'true' in the request) the immediate payment feature for the listing. <br> <br> To discover if a category supports immediate payment for an item, use <b>GetCategories</b> and look for the appearance of the <b>AutoPayEnabled</b> boolean field in the output for that category (identified by <b>CategoryID</b>). <b>AutoPayEnabled</b> is returned as an empty element if the category supports immediate payment, and is not returned at all if the category does not support immediate payment. <br> <br> Not applicable to Half.com. false AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetItemTransactions GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally AutoPay UseTopicAlias MotorsAutoPay UseTopicAlias This container is used by the seller to specify amounts and due dates for deposits and full payment on motor vehicle listings. <br> <br> The PaymentDetails container and its child fields are only applicable to vehicle listings on eBay Motors (US and CA). AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally MotorsPayment UseTopicAlias This container consists of information about the buyer's bidding history on a single auction item. <br><br> Not applicable to Half.com. GetMyeBayBuying BidList LostList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling BidList
DetailLevel: none, ReturnAll
Conditionally Listing upgrade that features the item in eBay search results on the mobile.de partner site. Applicable to eBay Germany. <br> <br> If 'true' in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site. <br> <br> Not applicable to Half.com. GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ItemReturnDescription, none, ReturnAll
Conditionally MobileDE UseTopicAlias Flag to indicate an item's eligibility for the PayPal Buyer Protection program. This field is only returned if 'true'. If this field is not returned, the item is not eligible for PayPal Buyer Protection. For more information on items that are eligible for PayPal Buyer Protection, see the <a href="http://pages.ebay.com/help/buy/paypal-buyer-protection.html#paypal">PayPal Buyer Protection</a> help page. <br> <br> Not applicable to Half.com. GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetBidderList Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally MiscellaneousItemFieldDifferences UseTopicAlias For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a <b>BuyItNowPrice</b> value enables the Buy It Now feature for the auction listing. <br><br> There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ListingStartPriceDetails</b>, and then look for the <b>ListingStartPriceDetails.MinBuyItNowPricePercent</b> field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid. <br><br> This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings. <br><br> Once an auction has bids (and the high bid exceeds the Reserve Price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem still return the <b>BuyItNowPrice</b> that the seller originally set for the listing. Use the <b>GetItem</b> call and look for the inclusion of the <b>Item.ListingDetails.BuyItNowAvailable</b> flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the <b>Item.SellingStatus.BidCount</b> value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not. <br><br> There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. <br><br> To remove this value when revising or relisting an item, use <b>DeletedField</b>. 16 SellrLimits UseTopicAlias AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBestOffers
DetailLevel: none, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Medium, Fine
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetMyeBayBuying WatchList BestOfferList BidList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling ActiveList ScheduledList SoldList UnsoldList DeletedFromSoldList DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetSellerEvents
DetailLevel: ReturnAll
Conditionally ReviseMotors UseTopicAlias Controls how eBay handles cases in which an ID specified in <b>PrimaryCategory</b> and/or <b>SecondaryCategory</b> no longer exists in the current category structure: If you pass a value of 'true' in <b>CategoryMappingAllowed</b>, eBay will look up the current category ID that is mapped to the same category and use the new category ID for the listing (if any). The new category ID will be returned in the response as <b>CategoryID</b> (for the primary category) or <b>Category2ID</b> (for the secondary category). If <b>CategoryMappingAllowed</b> is not set or contains a value of 'false' (the default), an error will be returned if a selected category ID no longer exists. <br> <br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItemFromSellingManagerTemplate AddItems AddLiveAuctionItem AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseLiveAuctionItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No CategoryMapping UseTopicAlias Identifies a Giving Works listing and the benefiting nonprofit charity organization selected by the charity seller (if any). If specified, the seller must also accept PayPal as a payment method for the item (see <b>Item.PaymentMethods</b>). <br><br> When you revise an item, you can add a charity to a non-charity listing, but you cannot remove or change the charity designation. The rules for adding a charity to a listing depend on the listing type. For an auction listing, you can revise an item to add a charity if there are more than 12 hours left for the listing (whether or not the item has bids). For a fixed-price listing, you can revise an item to add a charity if there are more than 12 hours left for the listing, and the item has not been sold. <br><br> When you relist an item, use <b>DeletedField</b> to remove charity information. <br><br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally MiscellaneousItemFieldDifferences UseTopicAlias UseTopicAlias CharityListings Defines the 2-letter country code set. <br><br> To see the list of currently supported country codes, and the English names associated with each code (e.g., KY="Cayman Islands"), call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>CountryDetails</b>, and then look for CountryDetails.Country fields in the response. <br><br> Most of the codes that eBay uses conform to the ISO 3166 standard, but some of the codes in the ISO 3166 standard are not used by eBay. Plus, there are some non-ISO codes in the eBay list. (Additional codes appear at the end of this code list and are noted as non-ISO.) <br><br> Also applicable as input to <b>AddItem</b> and related calls when you list items to Half.com (specify 'US'). AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate VerifyAddItem Yes GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse
Conditionally GetItemRecommendations Conditionally RelistItem ReviseItem RelistFixedPriceItem ReviseFixedPriceItem ReviseSellingManagerTemplate VerifyRelistItem No GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally This container is no longer supported as eBay Store Cross Promotions are no longer supported by the Trading API. <br><br> Container for cross-promoted items related to a specific item ID. The items are either upsell or cross-sell, according to the promotion method passed in the request. Not applicable to Half.com. GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally Currency associated with the item's price information. 3-letter ISO 4217 currency code that corresponds to the site specified in the listing request. Also applicable as input to <b>AddItem</b> and related calls when you list items to Half.com (specify USD). You cannot modify a listing's currency when you revise or relist an item. <br><br> To see the list of currently supported currency codes, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>CurrencyDetails</b>, and then look for the CurrencyDetails.Currency fields in the response. INR, CAD, CNY, HKD, AUD, CHF, MYR, EUR, PHP, PLN, USD, SGD, SEK, TWD, GBP AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations VerifyAddItem Yes GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetItemTransactions GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally GetBestOffers
DetailLevel: none, ReturnAll
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally FieldDifferences UseTopicAlias The seller's description of the item. In listing requests, you can submit your description using CDATA if you want to use HTML or XML-reserved characters in the description. An error is returned if this contains malicious JavaScript content. (For more information on eBay's HTML and JavaScript policy, see the <a href="http://pages.ebay.com/help/policies/listing-javascript.html">HTML and JavaScript policy</a> help topic.) <br><br> If you embed pictures in the description (by using IMG tags) instead of using <b>PictureURL</b>, but you want a camera icon to appear in search and listing pages, specify the following null-image URL in PictureURL: http://pics.ebay.com/aw/pics/dot_clear.gif. See "Including Pictures in an Item Listing" in the Trading API Guide. <br><br> Required for all listings, except listings that include eBay catalog product details. Optional when you list with product details and Item.ProductListingDetails.IncludePrefilledItemInformation is true. <br><br> <span class="tablenote"><b>Note:</b> In addition to including notes on flaws or wear and tear on an used item in the <b>Item.Description</b>, and including a <b>ConditionID</b> value, you can provide additional information about the condition of your used item through the <b>Item.ConditionDescription</b> string field. </span> <br> <b>For GetItem</b>: Item.Description can be empty when IncludePrefilledItemInformation is true and the seller did not write their own description. Item.Description doesn't return pre-filled descriptions from catalogs. The eBay site shows the catalog product description (if any) in the product details section of a listing. To retrieve a URL for the catalog product details page, see DetailsURL in FindProducts in the Shopping API. <br><br> Not applicable to Half.com. (For Half.com, use AttributeArray.Attribute with attributeLabel="Notes" to specify a brief description or note to the buyer.) 500000 (some sites may allow more, but the exact number may vary) AddFixedPriceItem AddItem AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally IncludePrefilledItemInformation #Request.Item.ProductListingDetails.IncludePrefilledItemInformation AddItems Conditionally IncludePrefilledItemInformation AddItems.html#Request.AddItemRequestContainer.Item.ProductListingDetails.IncludePrefilledItemInformation GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: ItemReturnDescription, ReturnAll
Always IncludePrefilledItemInformation #Response.Item.ProductListingDetails.IncludePrefilledItemInformation DetailsURL in FindProducts (Shopping API) http://developer.ebay.com/DevZone/Shopping/docs/CallRef/FindProducts.html#Response.Product.DetailsURL This field is applicable if you are modifying the item description. The value selected for this field will determine if the new text entered into the <b> Item.Description</b> field is added before (Prepend) or after (Append) the current text in the item description, or if the new text completely replaces the current text in the item description. ReviseItem ReviseSellingManagerTemplate ReviseFixedPriceItem No The distance used in a proximity search distance calculation. <br> <br> Not applicable to Half.com. If turned on at listing time, this flag allows the seller to offer one or more gift services to buyers, and a generic gift icon displays next to the listing's title in Search and View Item pages. <b>GiftIcon</b> must be included at listing time and set to '1' to be able to use one or more <b>GiftServices</b> options. The value of '1' indicates that this feature is on, and the value of '0' indicates that the feature is off. <br><br> Gift Services are only available on the following eBay sites: <ul> <li>Belgium (Dutch)</li> <li>Belgium (French)</li> <li>France</li> <li>Italy</li> <li>Netherlands</li> <li>Poland</li> <li>Spain</li> </ul> <br><br> To verify if Gift Services are enabled for an eBay site, call , call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ListingFeatureDetails</b>. Then look for GiftIcon=Enabled under the ListingFeatureDetails container in the response. <br><br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally This field allows the seller to offer optional gift services to the buyer. To offer one or more gift services to the buyer through an Add/Revise/Relist API call, the seller must also include the GiftIcon field and set that flag to 'true'. <br><br> Gift Services are only available on the following eBay sites: <ul> <li>Belgium (Dutch)</li> <li>Belgium (French)</li> <li>France</li> <li>Italy</li> <li>Netherlands</li> <li>Poland</li> <li>Spain</li> </ul> <br><br> This field is only returned in GetItem (and other calls that retrieve Item object) if it is set for the listing. <br><br> To verify if Gift Services are enabled for an eBay site, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ListingFeatureDetails</b>. Then look for GiftIcon=Enabled under the ListingFeatureDetails container in the response. <br><br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally Indicates whether an optional hit counter is displayed on the item's listing page and, if so, what type. See HitCounterCodeType for specific values. <br><br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Always GetSellerEvents
DetailLevel: none, ReturnAll
Always The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value.<br> <br> Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing.<br> <br> In order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and TransactionID to uniquely identify an order line item. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.)<br> <br> In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem.<br> <span class="tablenote"><b>Note:</b> Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see <a href="http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=468">Common FAQs on eBay Item IDs and other eBay IDs</a> in the Knowledge Base.</span> 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddOrder GetBestOffers RelistItem ReviseItem ReviseLiveAuctionItem VerifyRelistItem Yes RelistFixedPriceItem ReviseFixedPriceItem GetItemRecommendations Conditionally GetBidderList GetDispute Always GetOrders
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetItemTransactions GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetBestOffers
DetailLevel: none, ReturnAll
Conditionally GetItemsAwaitingFeedback GetMemberMessages Conditionally GetUserDisputes
DetailLevel: ReturnSummary, ReturnAll, none
Conditionally GetMyeBayBuying BestOfferList BidList LostList SecondChanceOffer WatchList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling ActiveList BidList ScheduledList SoldList UnsoldList DeletedFromSoldList DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally 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. <br><br> Not applicable to Half.com. GetBestOffers
DetailLevel: none, ReturnAll
Always GetBidderList GetDispute Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally GetItemsAwaitingFeedback GetMemberMessages Conditionally GetMyeBayBuying BestOfferList BidList LostList SecondChanceOffer WatchList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling ActiveList BidList ScheduledList SoldList UnsoldList DeletedFromSoldList DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No Contains the detail data for the Listing Designer theme and template (if either are used), which can optionally be used to enhance the appearance of the description area of an item's description. See ListingDesignerType for its child elements. <br><br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally 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). <br><br> The valid choice of values depends on the listing format (see Item.ListingType). For a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll and look for ListingDurations information. To set a duration of 1 day, the seller must have a Feedback score of at least 10. <br><br> 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. <br><br> Required for Half.com (but only specify GTC). ListingDurationCodeType GetCategoryFeatures GetCategoryFeatures.html#Response.FeatureDefinitions.ListingDurations FeesPerSite UseTopicAlias AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate VerifyAddItem Yes GetItemRecommendations RelistItem ReviseItem ReviseSellingManagerTemplate RelistFixedPriceItem ReviseFixedPriceItem VerifyRelistItem No GetBidderList Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetMyeBaySelling ScheduledList UnsoldList ActiveList
DetailLevel: none, ReturnAll
Conditionally This field can be used by the seller to activate one or more listing upgrades for a listing, such as a Bold Title, a Subtitle, or a Value Pack bundle. A ListingEnhancement field is required for each listing upgrade that the seller wants to activate. There is a small fee associated with each listing upgrade. See the <a href="http://pages.ebay.com/help/sell/ia/promoting_your_item.html">Listing Upgrades</a> help page for more information on the available listing upgrades. <br><br> The listing upgrades that are available vary by site and by the seller's account status. To discover which listing upgrades are available, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ListingFeatureDetails</b> and pass in the appropriate SiteID value. Then look for the ListingFeatureDetails container in the response. Listing upgrades will either be listed as 'Enabled' or 'Disabled'. <br><br> GetItem (and other calls that retrieve Items) will only return this field if one or more listing upgrades are set for the listing. <br><br> You cannot remove listing upgrades when you revise a listing. When you relist an item, use DeletedField to remove a listing upgrade. <br><br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The format of the listing the seller wants to use, such as auction style or fixed price.<br> <br> Optional for eBay.com listings (defaults to auction style) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing.<br> <br> Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). <br><br> FixedPriceItem AddFixedPriceItem Conditionally Unknown, Live, Auction, PersonalOffer, Shopping, StoresFixedPrice AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally ReviseItem Half half Conditionally GetBidderList Unknown, Auction, Half, PersonalOffer, StoresFixedPrice Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Unknown, Auction, Half, StoresFixedPrice Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Unknown, Auction, Half, PersonalOffer, Shopping, StoresFixedPrice Conditionally GetItemTransactions GetSellerTransactions Unknown, Auction, Half, Shopping, StoresFixedPrice
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetOrderTransactions Unknown, Auction, Half, Shopping, StoresFixedPrice
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetMyeBayBuying BidList LostList WatchList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Unknown, Auction, Half, StoresFixedPrice Conditionally GetMyeBaySelling ActiveList BidList ScheduledList SoldList UnsoldList DeletedFromSoldList DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Unknown, Auction, Half, StoresFixedPrice Conditionally GetSellerEvents
DetailLevel: ReturnAll
Unknown, Auction, Half, Shopping, StoresFixedPrice Conditionally Different Ways of Selling http://pages.ebay.com/help/sell/ia/formats.html ListingTypes UseTopicAlias GetCategoryFeatures GetCategoryFeatures.html#Response.FeatureDefinitions.ListingDurations FeesPerSite UseTopicAlias Indicates the geographical location of the item (along with Country) to be displayed on eBay listing pages. When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. <br><br> If you do not specify <strong>Location</strong>, you must specify <strong>Item.PostalCode</strong>. <br/><br/> <span class="tablenote"> <strong>Note:</strong> If you specify both <strong>Location</strong> and <strong>PostalCode</strong>, and eBay can determine a location that corresponds to the postal code, the postal code-derived location will be used for the listing. </span> For the Classified Ad format for eBay Motors vehicles, the value provided in the Location is used as item location only if the SellerContactDetails.Street and the SellerContactDetails.Street2 are empty. Else, the SellerContactDetails.Street and the SellerContactDetails.Street2 will be used for item location. <br><br> Also applicable as input to AddItem and related calls when you list items to Half.com. 45 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally 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. <br><br> 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. <br><br> Not applicable to Half.com. 100000 AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Conditionally Not currently operational. Not currently operational. Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. For the AddItem family of calls, at least one payment method is required. <br><br> Use GetCategoryFeatures to determine the payment methods that are allowed for a category on a site. For example, the response data of GetCategoryFeatures will show that on the US site, most categories only allow electronic payments. Also use GetCategoryFeatures to determine the default payment method for a site (see SiteDefaults.PaymentMethod). If a seller does not include at least one payment method in a Add/Revise/RelistItem API call, the default payment method is used for the listing. <br><br> Do not use <b>GeteBayDetails</b> to determine the payment methods for a site. <br><br> For a DE or AT seller's items that are subject to the new eBay payment process, only one <b>PaymentMethod</b> field will be returned, and the value will always be 'StandardPayment'. <br><br> If you specify multiple PaymentMethods fields, the repeating fields must be contiguous. For example, you can specify PayPalEmailAddress after a list of repeating PaymentMethods fields, but not between them:<br> <br> &lt;PaymentMethods&gt;VisaMC&lt;/PaymentMethods&gt;<br> &lt;PaymentMethods&gt;PayPal&lt;/PaymentMethods&gt;<br> &lt;PayPalEmailAddress&gt;mypaypalemail@ebay.com&lt;/PayPalEmailAddress&gt;<br><br> In general, if you separate repeating instances of a field, the results will be unpredictable. This rule applies to all repeating fields (maxOccurs="unbounded" or greater than 1) in the schema. See "Overview of the Schema" in the Trading API Guide.<br> <br> This field is not applicable to eBay Real Estate Ad format, Classified Ad format, or Half.com listings. <br> <br> <b>For ReviseItem and RelistItem only:</b> A listing must have at least one valid payment method. When you revise or relist an item and you specify a payment method that is invalid for the target site, eBay ignores the invalid payment method, applies the other valid changes, and returns a warning to indicate that the invalid payment method was ignored. If multiple payment methods were invalid, the warning indicates that they were all ignored. If you modify the listing so that it includes no valid payment methods, an error is returned. This situation could occur when the seller removes all valid payment methods or when all the payment methods specified for the item are no longer valid on the target site. PaymentMethodDifferences UseTopicAlias ListingAnItem UseTopicAlias (SetUserPreferences) SellerPaymentPreferences SetUserPreferences.html#Request.SellerPaymentPreferences UseTopicAlias SchemaOverview rules regarding repeating nodes AddFixedPriceItem AddItem AddItemFromSellingManagerTemplate AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem VerifyAddItem VerifyRelistItem Conditionally GetItemRecommendations ReviseSellingManagerTemplate IntegratedMerchantCreditCard Conditionally GetBidderList GetItems GetSellingManagerTemplates IntegratedMerchantCreditCard Conditionally GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
IntegratedMerchantCreditCard Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
IntegratedMerchantCreditCard Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
IntegratedMerchantCreditCard Conditionally Valid PayPal email address for the PayPal account that the seller will use if they offer PayPal as a payment method for the listing. eBay uses this to identify the correct PayPal account when the buyer pays via PayPal during the checkout process. (As a seller can have more than one PayPal account, you cannot necessarily rely on PayPal account data returned from GetUser for details about the account associated with the PayPal email address that the seller specifies.)<br> <br> Required if seller has chosen PayPal as a payment method (PaymentMethods) for the listing.<br> <br> For digital listings, the seller needs to use an email address that is associated with a PayPal Premier or PayPal business account. <br> <br> <b>For ReviseItem and RelistItem only:</b> To remove this value when you revise or relist an item, use DeletedField. When you revise a listing, if the listing has bids (or items have been sold) or it ends within 12 hours, you can add PayPalEmailAddress, but you cannot remove it.<br> <br> Not applicable to eBay Motors listings. <br> Not applicable to Half.com. ListingAnItem UseTopicAlias (SetUserPreferences) SellerPaymentPreferences SetUserPreferences.html#Request.SellerPaymentPreferences AddFixedPriceItem AddItem AddItemFromSellingManagerTemplate AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally Category ID for the first (or only) category in which the item is listed (or will be listed, if the item is new). A number of listing features have dependencies on the primary category. We have pointed out a few of the notable dependencies below. See the descriptions of the fields you are using to determine whether the feature you're supporting depends on the listing's primary category.<br> <br> <b>For the AddItem family of calls:</b> Use calls like GetCategories and GetCategoryFeatures to determine valid values for the site on which you are listing (see the eBay Web Services Guide for information on working with categories). Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill.<br> <br> There are a number of categories on some eBay sites that always add the Gallery feature (for free) when you include a picture in the listing and you don't specify the Gallery feature yourself. See GalleryType for information about fees that could be charged if you change the category in these cases.<br> <br> Coming soon: If you list with a catalog product, eBay may drop the primary category you specify and use the category that is associated with the product instead, if different.<br> <br> Not applicable to Half.com.<br> <br> <b>For ReviseItem only:</b> When revising a listing, you can change the primary category only if an item has no bids (or no items have sold) and the listing does not end within 12 hours. <br> <br> If you change the listing category, any Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the new category. See Item.AttributeSetArray. For the eBay US site, we suggest that you avoid including a category ID when you list with an external product ID, such as ISBN. See the KB article listed below for details.<br> <br> You cannot change the meta-categories for vehicles (i.e., you cannot change a truck to a motorcycle), but you can change the leaf category (e.g., change one motorcycle subcategory to another motorcycle subcategory). See the eBay Web Services Guide for additional rules. International sites (such as the eBay Germany site) have similar rules for revising vehicle categories. <br> <br> When you list an event ticket on the US site, you must specify the Event Tickets category as the primary category. Also, when revising a listing, you cannot change the primary category from another category to the Event Tickets category. (You need to specify the Event Tickets category when you initially list the item.)<br> <br> <b>For GetItemRecommendations only:</b> For GetItemRecommendations, use this value to control the category that is searched for recommendations. Specify the category in which the item will be listed. See <a href= "http://developer.ebay.com/DevZone/XML/docs/WebHelp/wwhelp/wwhimpl/js/html/wwhelp.htm?context=eBay_XML_API&topic=EngineRecs" >Getting Recommendations to Improve a Listing</a> in the eBay Web Services guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attribute engine. AddFixedPriceItem AddItem AddItems AddLiveAuctionItem AddSellingManagerTemplate GetItemRecommendations VerifyAddItem Yes GetItemRecommendations Conditionally RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem RelistFixedPriceItem ReviseFixedPriceItem VerifyRelistItem No GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally CategoryOverview UseTopicAlias MotorsListing UseTopicAlias (RelistItem) GalleryType RelistItem.html#Request.Item.PictureDetails.GalleryType The <b>PrivateListing</b> boolean field can be used by the seller in the Add/Relist/Revise family of calls to obscure item title, item ID, and item price from post-order Feedback comments left by buyers. Typically, it is not advisable that sellers use the Private Listing feature, but using this feature may be appropriate for sellers listing in Adults Only categories, or for high-priced and/or celebrity items. <br> <br> For <b>GetItem</b>, order retrieval calls, and other calls that retrieve the Item object, the <b>PrivateListing</b> field is only returned if 'true'. <br> <br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetItemTransactions GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally Specifies stock product information to include in a listing. Only applicable when listing items with product details. See the eBay Trading API Guide for information on listing with product details.<br> <br> As ProductID and ProductReferenceID are defined by eBay, they provide the most reliable means to identify a product. If you use one of the other industry identifiers (e.g., UPC), eBay attempts to find a matching product on your behalf and use it in the listing. If no match is found, you can try using FindProducts in the Shopping API to determine a ProductReferenceID.<br> <br> When you specify ProductListingDetails, you must specify at least one of the available identifiers (e.g., UPC). If you specify more than one (such as UPC and BrandMPN), eBay uses the first one that matches a product in eBay's catalog system. (This may be useful if you aren't sure which identifier is more likely to result in a match.)<br> <br> When you specify TicketListingDetails, you must specify the Event Tickets category as the primary category. For other product identifiers: If you list in two categories and the primary and secondary categories are both catalog-enabled, this product identifier should correspond to the primary category (not the secondary category). If only one category is catalog-enabled, the product identifier should correspond to the catalog-enabled category. <br> <br> <span class="tablenote"><b>Note:</b> As a general rule, the primary category is required. However, if you have trouble finding a catalog-enabled category, you may be able to omit the primary category (except for event tickets). If you do, eBay will attempt to determine an appropriate category based on the product ID (if we find a matching product). When you specify a category that corresponds to the product, your category is used. </span> If we don't find a match in our catalogs, we will list the item in the primary category you specified, without product details. We will not pre-fill the listing's item specifics in this case, and the identifier won't be surfaced in View Item or returned in GetItem. However, it will still be indexed for search on eBay, and it will be searchable by more third-party natural search engines. As this can help buyers find your listing more easily, we strongly recommend that you always use ProductListingDetails to pass in these values. (This product indexing behavior is only available if you use UPC, ISBN, EAN, or GTIN in ProductListingDetails. It is not available if you use ExternalProductID, and it may not be available if you exclusively use Item Specifics.)<br> <br> Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem request, but not both. (ExternalProductID is no longer recommended.) <br> <br> <b>For ReviseItem and RelistItem only:</b> If a listing includes product details and you change a category, the rules for continuing to include product details depend on whether or not the new category is mapped to a characteristic set associated with the same product ID. When you revise a listing, if it has bids or it ends within 12 hours, you cannot change the product ID and you cannot remove existing product data. However, you can change or add preferences such as IncludeStockPhotoURL, UseStockPhotoURLAsGallery, and IncludePrefilledItemInformation. To delete all catalog data when you revise or relist an item, specify Item.ProductListingDetails in DeletedField and don't pass ProductListingDetails in the request.<br> <br> <b>For GetMyeBayBuying only:</b> When products have been added to a buyer's Wish List, the product information is returned in ItemArray.Item.ProductListingDetails within the UserDefinedList node. Products can be added to a buyer's Wish List only. Does not apply to any other user-defined list. The ProductListingDetails node is not included for items in the Wish List. <br><br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddFixedPriceItem VerifyAddItem VerifyRelistItem No GetItemRecommendations Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally GetMyeBayBuying UserDefinedList
DetailLevel: none, ReturnAll
Conditionally The value indicates the quantity of items available for purchase in the listing. This field is required for all auction listings and for non-variation, fixed-price listings. For auction listings, this value is always '1'. For a non-variation, fixed-price listing, the <b>Item.Quantity</b> value indicates the number of identical items the seller has available for purchase in the listing. <br><br> <b>For AddFixedPriceItem, VerifyAddFixedPriceItem, RelistFixedPriceItem, and ReviseFixedPriceItem:</b> in a multi-variation, fixed-price listing, the <b>Item.Quantity</b> should not be used; instead, the quantity of each variation is specified in the <b>Variation.Variation.Quantity</b> field instead. See the <a href=" http://pages.ebay.com/help/sell/listing-variations.html">Creating a listing with variations</a> eBay Help page for more information on variations. <br><br> <b>For RelistItem and RelistFixedPriceItem:</b> Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was 10, and 3 items have been sold, eBay sets the relisted item's Quantity to 10 by default, and not 7. So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests.<br> <br> When eBay auto-renews a GTC listing (ListingDuration=GTC) on your behalf, eBay relists with correct quantity available. <br><br> <span class="tablenote"><b>Note:</b> There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The <b>GetMyeBaySelling</b> call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. </span> <br> <b>For GetSellerEvents:</b> Quantity is only returned for listings where item quantity is greater than 1. <br><br> <b>For GetItem and related calls:</b> This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. <br><br> <b>For order line item calls with variations:</b> 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). <br> <br> <b>For GetDispute:</b> Quantity is the number of items being raised in the dispute. <br> <br> For SetCart input, this is only required if the parent container is submitted. <br><br> Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. <br> SellrLimits UseTopicAlias Selecting a Selling Format http://pages.ebay.com/help/sell/formats.html AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem VerifyAddItem VerifyRelistItem Conditionally GetItemRecommendations ReviseItem ReviseSellingManagerTemplate No GetBidderList GetDispute Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally GetMyeBaySelling ActiveList ScheduledList SoldList UnsoldList DeletedFromSoldList DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. <br><br> Not supported as input in ReviseItem. Use SetUserNotes instead. <br><br> <b>For GetMyeBayBuying</b> 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). <br><br> 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). <br><br> Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) AddFixedPriceItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem VerifyAddItem VerifyRelistItem No GetMyeBayBuying GetMyeBaySelling Conditionally No longer used by any site. Applicable only to re-listing an item. If true, creates a link in the item's old listing for the item that points to the new relist page, which accommodates users who might still look for the item under its old item ID. Not applicable to Half.com. RelistItem No RelistFixedPriceItem No The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support a reserve price. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the Trading API Guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings.<br> <br> You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the Trading API Guide for validation rules when revising US Motors listings.<br> <br> The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing. <br> <br> Not applicable to Half.com. 16 AddItem AddItems AddLiveAuctionItem AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetMyeBaySelling ActiveList ScheduledList SoldList UnsoldList DeletedFromSoldList DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally ReviseMotors UseTopicAlias Reserve Price (eBay Web site help) http://pages.ebay.com/help/sell/reserve.html Fees Overview (eBay Web site help) http://pages.ebay.com/help/sell/fees.html An output value only, indicates whether an item has been revised since the listing became active and, if so, which among a subset of properties have been changed by the revision. <br><br> Not applicable to Half.com. GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always Allows the user to specify the time that the listing becomes active on eBay. To schedule the listing start time, specify a time in the future in GMT format. In GetItem and related calls, the scheduled time is returned in StartTime. For ReviseItem, you can modify this value if the currently scheduled start time is in the future. <br><br> When you schedule a start time, the start time is randomized within 15-minute intervals. Randomized start times applies to the following sites: <br> <code>AT, BEFR, BENL, CH, DE, ES, FR, IE, IT, NL, PL, UK</code> <br><br> Also see the following article in the Knowledge Base: <a href= "http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1473" >Why scheduled time is sometimes getting reset</a>. <br><br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddFixedPriceItem VerifyAddItem VerifyRelistItem No ID for second category in which the item is listed (also see Item.PrimaryCategory). <br><br> <b>For the AddItem family of calls:</b> Listing an item in a second category is optional. Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill. <br> <br> Not applicable to Half.com. <br> <br> On the eBay UK, Ireland, Germany, Austria, Switzerland, and Italy sites you can list Store Inventory listings in two categories. On the eBay US and other sites, you cannot list Store Inventory listings in two categories.<br> <br> 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. <br> <br> If eBay has designated a category as a value category (see ValueCategory in GetCategoryFeatures), items in that category cannot be listed in two categories. For example, if your AddItem request includes a primary or secondary category that is a value category, then eBay drops SecondaryCategory and lists the item with only the PrimaryCategory you selected. Also, if the listing request includes item specifics (in ItemSpecifics or AttributeSetArray) that are associated with SecondaryCategory, eBay drops those values when we drop SecondaryCategory. (The same logic is used if you revise an existing listing to add a secondary category or to change one of the categories: If either the primary or secondary category is a value category, eBay drops the secondary category from your request.)<br> <br> To remove this value when relisting an item, use DeletedField. <br><br> <b>For ReviseItem only:</b> When revising a listing, you can add or change the secondary category only if the listing has no bids (or no items have sold) and it does not end within 12 hours. If you change the secondary category, any corresponding Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the category. See Item.AttributeSetArray.<br> <br> When you revise an item, you can change the secondary category from a Motors Parts & Accessories category to an eBay category or vice versa if the listing has no bids (or no items have sold) and it does not end within 12 hours. <br> <br> <b>For GetItemRecommendations only:</b> For GetItemRecommendations, use this to control the category that will be searched for recommendations. Specify the category in which the item will be listed. See the Trading API Guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attributes engine. 10 CategoryOverview UseTopicAlias AddFixedPriceItem AddItem AddItems AddLiveAuctionItem AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseLiveAuctionItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally ID for a second category that eBay added as a free promotion. You cannot add this yourself. Only returned if the item was listed in a single category and eBay added a free second category. <br><br> Not applicable to Half.com. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally Container for information about this listing's seller. <br> <br> Not applicable to Half.com. <br><br> Returned by GetItemsAwaitingFeedback if Buyer is making the request. GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetItemTransactions
DetailLevel: none, ReturnAll
Conditionally GetItemsAwaitingFeedback
DetailLevel: none, ReturnAll
Conditionally GetMyeBayBuying BestOfferList BidList LostList WatchList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling BidList
DetailLevel: none, ReturnAll
Conditionally GetBidderList Always AddItem AddItems AddSellingManagerTemplate ReviseItem ReviseSellingManagerTemplate VerifyAddItem Conditionally Various details about the current status of the listing, such as the current number of bids and the current high bidder. <br><br> Not applicable to Half.com. GetBidderList GetDispute Always GetSellerEvents
DetailLevel: none, ReturnAll
Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally GetMemberMessages Conditionally GetMyeBayBuying BestOfferList BidList LostList WatchList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling ActiveList BidList ScheduledList SoldList UnsoldList DeletedFromSoldList DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs.<br> <br> 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.<br> <br> For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout.<br/> <br/> <span class="tablenote"> <strong>IMPORTANT:</strong> To avoid loss of shipping details when revising a listing, you must include all <strong>ShippingDetails</strong> fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing. </span> <br> Shipping details are not applicable to Real Estate listings and Half.com. <br><br> <b>GetMyeBayBuying, GetMyeBaySelling</b>: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.) AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetMyeBayBuying BestOfferList BidList DeletedFromLostList DeletedFromWonList WatchList WonList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling
DetailLevel: none, ReturnAll
Conditionally ShippingGettingCosts UseTopicAlias RevisingItems UseTopicAlias restrictions on changing item properties with ReviseItem An international location or region to which the seller is willing to ship, regardless of shipping service. The country of the listing site is added by eBay. Use <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ShippingLocationDetails</b> to determine which international locations are valid for the site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields. <br><br> 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. <br><br> 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). <br><br> Not applicable to Half.com. length of longest name in ShippingRegionCodeType and CountryCodeType ShippingRegionCodeType, CountryCodeType AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally UseTopicAlias ShipToLocation UseTopicAlias GeteBayDetails The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches, and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing.<br> <br> 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).<br> <br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems GetItemRecommendations RelistFixedPriceItem RelistItem VerifyAddItem VerifyRelistItem Yes AddSellingManagerTemplate No GetBidderList GetDispute Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetItemTransactions GetSellerTransactions Conditionally GetOrders
DetailLevel: none, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally GetMyeBayBuying BestOfferList BidList LostList SecondChanceOffer WatchList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling BidList
DetailLevel: none, ReturnAll
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally SitesIntro UseTopicAlias TargetSite UseTopicAlias FieldDifferences UseTopicAlias This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted. <br><br> <b>For auction listings:</b> competitive bidding starts at this value. Once at least one bid has been placed, <b>StartPrice</b> remains the same but <b>CurrentPrice</b> is increased to the amount of the current highest bid. If <b>ReservePrice</b> is also specified, the value of <b>StartPrice</b> must be lower than the value of <b>ReservePrice</b>. <br><br> <b>For fixed-price listings: </b> This is the fixed-price at which a buyer may purchase the item. <br><br> For both auction and fixed-price listings, there is a minimum value that may be specified as a <b>StartPrice</b> value. These minimum values vary per site. To retrieve these minimum values for a site, call <b>GeteBayDetails</b> passing in your <b>SiteID</b> value as a header, and using <b>ListingStartPriceDetails</b> as a <b>DetailName</b> value. In the <b>GeteBayDetails</b> response, look for the <b>ListingStartPriceDetails.StartPrice</b> fields for the 'Chinese' and 'FixedPriceItem' listing types. <br><br> <span class="tablenote"><b>Note:</b> There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The <b>GetMyeBaySelling</b> call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. </span> <b>GetMyeBaySelling</b> does not return <b>Item.StartPrice</b> for fixed-price items; it returns <b>Item.SellingStatus.CurrentPrice</b>. <br><br> <b>For AddFixedPriceItem and VerifyAddFixedPriceItem:</b> Required when no variations are specified. If variations are specified, use <b>Variation.StartPrice</b> for each variation instead. <br> <br> Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. SellrLimits UseTopicAlias AddFixedPriceItem AddItem AddItems AddLiveAuctionItem AddSellingManagerTemplate RelistFixedPriceItem ReviseFixedPriceItem VerifyAddItem Yes GetItemRecommendations ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem RelistItem VerifyRelistItem No GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetMyeBayBuying BidList LostList WatchList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling ActiveList BidList ScheduledList SoldList UnsoldList DeletedFromSoldList DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Conditionally Contains information related to the item in the context of a seller's eBay Store. Applicable for auction and fixed-price listings listed by eBay Stores sellers.<br> <br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally 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).<br> <br> Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle.<br> <br> When you revise a item, you can add, change, or remove the subtitle.<br> <br> Not applicable to Half.com. 55 AddFixedPriceItem AddItem AddItems AddLiveAuctionItem AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseLiveAuctionItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally AddFixedPriceItem VerifyAddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem No GetMyeBayBuying BestOfferList BidList LostList SecondChanceOffer WatchList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally RelistDeletedField UseTopicAlias (RelistItem) DeletedField RelistItem.html#Request.DeletedField MotorsSubtitle UseTopicAlias Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com. GetBidderList Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetMyeBayBuying BestOfferList BidList SecondChanceOffer WatchList Conditionally
DetailLevel: none, ReturnAll
 GetMyeBaySelling ActiveList BidList ScheduledList SoldList UnsoldList DeletedFromSoldList DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally Name of the item as it appears in the listing or search results. Title is required for most items. This field is only optional if you leverage Pre-filled Item Information by using the Item.ProductListingDetails or Item.ExternalProductID containers. <br><br> You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) <br><br> <b>For the AddItem family of calls</b>: Not applicable to Half.com. <br> <br> <b>For ReviseItem and ReviseFixedPriceItem</b> You can only add or change the item title if the listing has no bids (for auctions) or sales (for fixed-price listings) and the listing does not end within 12 hours.<br> <br> <b>For GetItemRecommendations</b>: More keywords in the title usually result in more relevant Listing Analyzer recommendations. 80 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations VerifyAddItem Conditionally RelistItem ReviseItem ReviseSellingManagerTemplate RelistFixedPriceItem ReviseFixedPriceItem VerifyRelistItem No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally GetItemsAwaitingFeedback GetMemberMessages Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Conditionally GetMyeBayBuying BestOfferList BidList LostList SecondChanceOffer WatchList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling ActiveList ScheduledList SoldList UnsoldList DeletedFromSoldList DeletedFromUnsoldList BidList
DetailLevel: none, ReturnAll
Conditionally GetBidderList GetDispute Always GetOrders
DetailLevel: none, ReturnAll
Always GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally Universally unique constraint tag. Use UUID to ensure that you only list a particular item once, particularly if you are listing many items at once. If you add an item and do not get a response, resend the request with the same UUID. If the item was successfully listed the first time, you will receive an error message for trying to use a UUID that you have already used. The error will also include the item ID for the duplicated item and a boolean value indicating whether the duplicate UUID was sent by the same application. <br><br> We recommend you use Item.UUID with calls that add item objects (for example, AddItem and RelistItem). For calls that modify an existing item, such as ReviseItem, use InvocationID instead. <br><br> The UUID can only contain digits from 0-9 and letters from A-F and must be 32 characters long. The UUID value must be unique across all item listings on all sites. <br><br> Also applicable as input to AddItem and related calls when you list items to Half.com. 32 AddFixedPriceItem AddItem AddItems AddLiveAuctionItem AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally Container for eBay's VAT features. A business seller can choose to offer an item exclusively to bidders and buyers that also represent businesses. Only applicable when the item is listed in a B2B-enabled category (on a site that supports B2B business features).<br> <br> <span class="tablenote"><strong>Note:</strong> The India site (Global ID 203) does not accept VAT values in item listings. If you submit an item to the India site with a VAT value, eBay generates a warning message that indicates the listing was accepted, but the VAT value was removed. To include the VAT, relist the item with a Price value that includes the VAT. Sellers are solely responsible for compliance relating to tax legislation in India. </span> <br><br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally B2BVAT UseTopicAlias BusinessFeatureFieldDifferences UseTopicAlias The seller is on vacation (as determined by the seller's store preferences) in two cases: i.) the item is a Store Inventory item and the seller has chosen to hide Store Inventory items while on vacation, and ii.) the seller has chosen to add a message to listed items while on vacation. <br><br> Not applicable to Half.com. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetSellerEvents
DetailLevel: ReturnAll
Conditionally 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. <br> <br> Not applicable to Half.com. GetSellerEvents
DetailLevel: ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetMyeBaySelling Conditionally The number of page views for the item. This number is calculated by eBay and cannot be set via the API. Returned if the hit counter type is BasicStyle, RetroStyle, or HiddenStyle. For HiddenStyle, HitCount is returned only if the requestor is the item's seller. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally If true: all buyer requirements (from <b>Item.BuyerRequirementDetails</b> or Buyer requirements preferences in My eBay) are ignored. <br> <br> If false (or omitted): <b>Item.BuyerRequirementDetails</b> or Buyer requirements preferences are used, with <b>Item.BuyerRequirementDetails</b> having the higher precedence. false AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally <b>For Add/Revise/Relist/Verify calls:</b> This container is used to enable the Best Offer feature on a listing. The Best Offer feature is not available for auction listings. <br> <br> For <b>GetItem</b> and other calls that retrieve item data, this container will include the status (<b>GetMyeBayBuying</b> 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. <br> <br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally GetMyeBayBuying BestOfferList Conditionally
DetailLevel: none, ReturnAll
 GetMyeBaySelling ActiveList Conditionally
DetailLevel: none, ReturnAll
 True if eBay provided a central location as a result of the user not specifying a location. This typically occurs when the seller specifies PostalCode without Location. <br> <br> Not applicable to Half.com. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally As of July 1, 2011, third-party applications can no longer be used for checkout. All purchased items must go through the eBay Checkout flow. <br><br> This field can no longer be passed into the Add Item family of calls. <br><br> This field will be returned in some calls (that return the Item container) if it was set to True at listing time (for listings created before July 1, 2011). If this field was set to True at listing time, the user must include this field and set it to False in the Relist and Revise Item family of calls. Otherwise, the caller may get an error. 729 NoOp 729 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate VerifyAddItem No GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyRelistItem No Indicates whether the seller's tax table is to be used when applying and calculating sales tax for an order line item. A sales tax table can be created programmatically using the SetTaxTable call, or it can be created manually in My eBay's Selling Preferences. If UseTaxTable is set to true, the values contained in the seller's sales tax table will supersede the values contained in the Item.ShippingDetails.SalesTax container (if included in the request).<br> <br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No UseTopicAlias SalesTax Indicates whether the seller has committed to the GetItFast shipping rules for this listing. If the GetItFast field is set to true, and the seller's first priority domestic shipping service (the service that has the ShippingServicePriority field set to 1) is an expedited shipping service, then every shipping service offered for this listing is considered a GetItFast service. Therefore, the seller commits to delivering the item to the buyer-selected shipping service within one day. <br> <br> Not supported for UK Store Inventory format items. <br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally UseTopicAlias SalesTax MiscellaneousItemFieldDifferences UseTopicAlias Applicable for listings in vehicle categories on the US eBay Motors site and eBay Canada site. (No business effect if specified for other categories or sites, as the Web site will not display the information to buyers.) If true, the buyer is responsible for vehicle pickup or shipping. If false, specify vehicle shipping arrangements in the item description. Default is true. (The description can also include vehicle shipping arrangements when this value is true.) If the item has bids or ends within 12 hours, you cannot modify this flag. Do not specify ShippingDetails.ShippingServiceOptions for vehicle listings. <br><br> 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. <br><br> Not applicable to Half.com. AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally This feature is no longer supported. This field will be removed from the schema in an upcoming release. Applicable to US eBay Motors vehicle listings only. If false, the vehicle was not considered for a limited warranty by eBay. If your application lists Motors vehicles, you were required to provide the seller with an opportunity to indicate whether the vehicle has not been modified and is not a special type (e.g., Corvette ZR1). If LimitedWarrantyEligible was passed in, it meant the application presented the seller with checkboxes to indicate this information. If true, the seller verified that the vehicle has not been modified and is not a special type. If false, the seller verified that vehicle has been modified or it is a special type. Passing a value of true did not guarantee that eBay would offer a limited warranty. It only made the listing eligible for consideration. <br><br> Not applicable to Half.com. Returns a note from eBay displayed below items in the user's My eBay account. <br> <br> Not applicable to Half.com. GetMyeBayBuying
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling ActiveList ScheduledList UnsoldList Conditionally
DetailLevel: none, ReturnAll
 Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. <br> <br> Not applicable to Half.com. GetMyeBaySelling Conditionally Whether or not the item is a relisted item. This value is determined by eBay and cannot be set. Only returned if the item was relisted. <br><br> Note that when an item is relisted and is given a new ItemID, the original item shows Relisted = true, but the new item does NOT show Relisted = true. In this context, the new item is a new listing, not a "Relisted" one. GetMyeBaySelling Conditionally UnsoldList Specifies how many of a certain item are available.<br> <br> Not applicable to Half.com. GetMyeBayBuying WatchList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling ActiveList BidList ScheduledList SoldList UnsoldList DeletedFromSoldList DeletedFromUnsoldList
DetailLevel: none, ReturnAll
Conditionally A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.)<br> <br> A SKU is not required to be unique, when you track listings by their ItemID (the default tracking method). A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs.<br> <br> If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method. <br> <br> If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing.<br> <br> For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. <br> <br> <span class="tablenote"><b>Note:</b> The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. </span> <b>For revising and relisting only:</b> 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.)<br> <br> For GetMyeBaySelling, this is only returned if set. <br> Not applicable to Half.com. 50 AddFixedPriceItem AddItem AddItems AddLiveAuctionItem AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList Conditionally GetOrders
DetailLevel: none, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetMyeBaySelling Conditionally eBay Merchant Data API AddFixedPriceItem and ReviseFixedPriceItem http://developer.ebay.com/DevZone/merchant-data/CallRef/index.html If this field is included in the request and set to 'true', eBay will auto-fill some of a listing's Item Specifics values based on the listing's category (or categories). Auto-filling Item Specifics based on a category is not the same as using Pre-filled Item Information based on a catalog product (see <b>ProductListingDetails</b>). If you set <b>CategoryBasedAttributesPrefill</b> to 'true', it is recommended that you also include and set the <b>Item.CategoryMappingAllowed</b> value to 'true', so you can be assured that your item will pick up the Item Specifics values from the correct category (categories). This field will be ignored if the category does not support auto-filling attributes. <br> <br> If you also pass in Item Specifics through the <b>Item.ItemSpecifics</b> container in the request, these values will override any auto-filled values for the same Item Specifics. Once you have overridden the value of an auto-filled Item Specifics for a given listing, eBay will not auto-fill it on subsequent <b>ReviseItem</b> requests (even if you remove the overridden value from the Item Specific in the <b>ItemSpecifics</b> container). <br> <br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No Container for values that indicate whether a listing uses the Buy It Now feature, whether a listing is no more than one day old, and whether a listing has an image associated with it. <br><br> Not applicable to Half.com. 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. <br/><br/> eBay derives a geographical location from the postal code to display on eBay listing pages. If you do not specify <strong>PostalCode</strong>, you must specify <strong>Item.Location</strong>. <br/><br/> <span class="tablenote"> <strong>Note:</strong> If you specify both <strong>PostalCode</strong> and <strong>Location</strong>, and eBay can determine a location that corresponds to the postal code, the postal code-derived location will be used for the listing. </span> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always Indicates whether details about shipping costs and arrangements are specified in the item description. <br> <br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally UseTopicAlias SearchResultsAndShippingCosts <b>This field will be removed in a future release. </b> New applications should use ProductListingDetails instead. 773 NoOp 889 Item.ProductListingDetails AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations VerifyAddItem Conditionally Unique identifier for a Half.com item. Must be an alphanumeric value (with no symbols) that is unique across the seller's active (unsold) inventory on Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. Only returned from GetOrders if the seller specified a value when the item was listed. You cannot revise this field. <br><br> Not applicable to eBay.com listings. 100 AddItem AddItems AddSellingManagerTemplate GetItemRecommendations ReviseItem ReviseSellingManagerTemplate VerifyAddItem No GetOrders
DetailLevel: none, ReturnAll
Conditionally Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture.<br> <br> <br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Yes GetBidderList Conditionally GetMyeBayBuying BestOfferList BidList SecondChanceOffer WatchList LostList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none,ReturnAll
Conditionally GetMyeBaySelling ActiveList ScheduledList SoldList UnsoldList DeletedFromSoldList DeletedFromUnsoldList BidList
DetailLevel: none, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Pictures UseTopicAlias 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). <br><br> <b>For the AddItem family of calls:</b> Required for listings in certain categories when certain shipping services (with delivery) are offered. See HandlingTimeEnabled in GetCategoryFeatures. The seller sets this field to a positive integer value indicating the number of days. For a list of allowed values on each eBay site, use <b>GeteBayDetails</b> with <b>DetailName</b> set to <code>DispatchTimeMaxDetails</code>. (Typical values are 0, 1, 2, 3, 4, 5, 10, 15, or 20, but this can vary by site and these may change over time.) <br><br> Valid for flat and calculated shipping. Does not apply when there is no shipping, when it is local pickup only or when it is freight shipping. For example, when <strong>ShippingService</strong>=<code>Pickup</code> or <strong>ShipToLocations</strong>=<code>None</code>, then <b>DispatchTimeMax</b> is not required. <br/><br/> A <b>DispatchTimeMax</b> value of <code>0</code> indicates same day handling for an item. In this case, the seller's shipping commitment depends on the <em>order cut off time</em> set in the seller's user preferences. This defaults to 2:00 PM local time on most sites, which can be overridden by using <strong>SetUserPreferences</strong> to set <strong>DispatchCutoffTimePreference.CutoffTime</strong> for the eBay site on which the item is listed. For orders placed (and cleared payment received) before the local order cut off time, the item must be shipped by the end of the current day. For orders completed on or after the order cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays). <br/><br/> <span class="tablenote"> <strong>Note:</strong> Same day handling is available on the eBay Sandbox for release <strong>817</strong>. It will become available on the production site as of Seller Release <strong>13.1</strong>. </span> With Add, Relist, Revise and Verify calls, if you wish to indicate that a listing with flat or calculated shipping has no handling time commitment, submit <b>Item.DispatchTimeMax</b> as an empty field. <br/><br/> To add Get It Fast to listings (for domestic shipping), in addition to setting <strong>GetItFast</strong> to true, <strong>DispatchTimeMax</strong> must be set to <code>0</code> or <code>1</code> and the seller must specify at least one qualifying expedited shipping service. <br><br> <span class="tablenote"> <b>Note:</b> To receive a Top-Rated Plus seal for their listing, Top-Rated Sellers must offer same day or 1-day handling (<b>DispatchTimeMax</b>=<code>0</code> or <b>DispatchTimeMax</b>=<code>1</code>) and accept returns (<b>ReturnPolicy.ReturnsAcceptedOption=ReturnsAccepted</b>). Top-Rated listings qualify for the greatest average boost in Best Match and the 20 percent Final Value Fee discount. For more information on changes to eBay's Top-rated seller program, see the <a href="http://pages.ebay.com/help/sell/top-rated.html">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> page. </span> <b>For ReviseItem only:</b> 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. <br><br> <b>For GetItem:</b> GetItem returns DispatchTimeMax only when shipping service options are specified for the item and the seller specified a dispatch time. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally (GetCategoryFeatures) SiteDefaults.HandlingTimeEnabled GetCategoryFeatures.html#Response.SiteDefaults.HandlingTimeEnabled SameDayHandling UseTopicAlias details about same day handling Specifies that Skype-related information is included with an item listing, including, for example, Skype Voice. Skype-related information provides buttons that enable potential buyers to contact sellers through Skype. Information about Skype is available at www.Skype.com. If all of the prerequisites for adding Skype buttons to listings are met (see the eBay Web Services Guide), you can make communication through Skype available in listings. SkypeEnabled must be true if SkypeID and SkypeContactOption are specified. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The Skype name of the seller. Requires that SkypeEnabled is set to true. Available if the seller has a Skype account and has linked it (on the eBay site) with his or her eBay account. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally Indicates the Skype contact option that the seller and buyer can use to communicate about the listing. For Skype communication to be possible, the <b>SkypeEnabled</b> flag must be included and set to 'true'. The seller must also have a Skype account that is linked with his or her eBay account. <br><br> More than one Skype contact option may be specified. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally Indicates, when true, that an item is available by Best Offer. Indicates, when true, that an item is available locally. As of July 1, 2011, third-party applications can no longer be used for checkout. All purchased items must go through the eBay Checkout flow. <br><br> This field can no longer be passed into the Add Item family of calls. <br><br> This field will be returned in some calls (that return the Item container) if it was set to True at listing time (for listings created before July 1, 2011). If this field was set to True at listing time, the user must include this field and set it to False in the Relist and Revise Item family of calls. Otherwise, the caller may get an error. <br><br> Be aware that you may need to use <b>SetNotificationPreferences</b> to change the <b>ApplicationURL</b> value if you were formerly having Checkout notifications sent to your third-party checkout application. <br><br> 729 NoOp 729 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate VerifyAddItem No GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyRelistItem No GetBidderList Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally UseTopicAlias PlatformNotifications Container consisting of the ProStores store name and user name. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally Contact information for sellers using the Classified Ad format for eBay Motors vehicles categories. To remove seller contact information when revising or relisting an item, use DeletedField. The seller contact details for the primary and secondary phone numbers cannot be deleted individually. <br><br> To provide City, State, and Zip code information in SellerContactDetails use the following field:<br> Item.SellerContactDetails.Street2 <br><br> To delete the secondary phone number, for example, you must delete all of the secondary phone fields:<br> Item.SellerContactDetails.Phone2AreaOrCityCode<br> Item.SellerContactDetails.Phone2CountryCode<br> Item.SellerContactDetails.Phone2CountryPrefix<br> Item.SellerContactDetails.Phone2LocalNumber ClassifiedAdListings UseTopicAlias AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally The number of questions asked about this item. Applies to eBay Motors Pro applications only. GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally 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. GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally 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. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally 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. GetMyeBaySelling ActiveList UnsoldList
DetailLevel: none, ReturnAll
Conditionally Specifies the number of new leads (unanswered emails) buyers have posted about the item. GetMyeBaySelling ActiveList
DetailLevel: none, ReturnAll
Conditionally A list of Item Specific name and value pairs that the seller specified for the item.<br> <br> Item Specifics describe well-known aspects of an item or product in a standard way, to help buyers find that type of item or product more easily. or example, "Publication Year" is a typical aspect of books, and "Megapixels" is a typical aspect of digital cameras.<br> <br> In the AddItem family of calls, use Item.ItemSpecifics to specify custom Item Specifics.<br> <br> To determine which categories support custom Item Specifics, use GetCategoryFeatures.<br> <br> To retrieve recommended Item Specifics, use GetCategorySpecifics.<br> <br> With GetItem, this is only returned when you specify IncludeItemSpecifics in the request (and the seller included custom Item Specifics in their listing).<br> <br> <b>For ReviseItem only:</b> When you revise a listing, if the listing has bids and ends within 12 hours, you cannot change or add Item Specifics. If the listing has bids but ends in more than 12 hours, you cannot change existing Item Specifics, but you can add Item Specifics that were not previously specified.<br> <br> To delete all Item Specifics when you revise or relist, specify Item.ItemSpecifics in DeletedField and don't pass ItemSpecifics in the request.<br> <br> <span class="tablenote"><b>Note:</b> To specify an item's condition, use the ConditionID field instead of a condition item specific. Use GetCategoryFeatures to see which categories support ConditionID and to get a list of valid condition IDs. (If you specify ConditionID and you also specify Condition as a custom item specific, eBay drops the condition item specific.) </span> ItemSpecifics UseTopicAlias Seller Central: Changes to Item Specifics http://pages.ebay.com/sellerinformation/news/itemspecific.html AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem AddSellingManagerTemplate ReviseSellingManagerTemplate VerifyRelistItem No GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GroupCategoryID is returned if there is a value of BestMatchCategoryGroup in the Order field for the GetSearchResults call. However, the results depend on the items and groups requested. <br> <br> The Best Match algorithm will try to evenly fit the items and return groups of 'Best Matching' Categories. A 'category group' can be a parent category that contains the best-matching items from several of its subcategories. Within each category group, items will be also sorted by best match. The only condition when you may not get a GroupCategoryID returned at all is when the request is for one group and there is more than one category that has matching items. Very rarely, the same item will appear once in the group for its primary category and once in another group for its secondary category, in the same result set. Also very occasionally, a Store Inventory Item can appear in the results before a regular listing. The pay-per-lead feature is no longer available, and this field is scheduled to be removed from the WSDL. Bid groups are only applicable to the Bid Assistant feature, which is a feature that has been retired. This field is scheduled to be removed from ItemType. Container consisting of details related to whether or not the item is eligible for buyer protection and which of the buyer protection programs will cover the item. This container is not returned if the item is not eligible for eBay or PayPal buyer protection. GetItem GetSellingManagerTemplates Conditionally Indicates a specific type of lead generation format listing, such as classified ad or local market Best Offer listing. Only applicable when ListingType=LeadGeneration. <br><br> <span class="tablenote"><b>Note:</b> ListingSubtype2 replaces the deprecated ListingSubtype field. If both are specified in a request, ListingSubtype2 takes precedence. </span> About Local Market Listings http://pages.ebay.com/help/sell/motors-selling-locally.html Advertising with Classified Ads http://pages.ebay.com/help/sell/f-ad.html AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally Indicates whether the seller allows the bidder to request mechanical inspection services from RAC. For Car category listings on the UK site. false GetItem GetSellingManagerTemplates Conditionally Specifies whether the following Business Seller fields have been updated for the item specified in the request: First Name, Last Name, Fax, Email Address, Additional Contact Information, Trade Registration Number, VAT Identification Number. ReviseItem ReviseSellingManagerTemplate No Flag to indicate whether the item's Return Policy has been updated as part of the revised listing. ReviseItem ReviseSellingManagerTemplate No Specifies the details of policy violations if the item was administratively canceled. GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates Conditionally 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 <a href=" http://pages.ebay.com/help/sell/globalexposure.html">Getting exposure on international sites</a> for full requirements on using this feature. There is a small listing fee for each country specified as a Cross Border Trade country. <br><br> 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. ListingsAvailableOtherSites UseTopicAlias AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always 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. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section. GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally When this container is present in an AddItem or AddFixedPriceItem call, all buyer requirements for the resulting listing are set by this container. Furthermore, individual buyer requirements cannot be modified or added when including this container in a ReviseItem call. The ReviseItem call needs to provide the entire set of buyer requirements to modify or add any of the requirements. Unless otherwise specified, most buyer requirements are only returned if the caller is the seller. All global My eBay Buyer Requirements are overridden by the contents of this container. This means that buyer requirements set in My eBay cannot be combined with buyer requirements included in this container. <br> <br> Not applicable to Half.com. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally Selecting Buyer Requirements (eBay Web site help) http://pages.ebay.com/help/sell/buyer-requirements.html Container that describes the seller's return policy. Most categories on most eBay sites require the seller to include a return policy through the ReturnPolicy container. <br> <br> <b>For the AddItem family of calls:</b> Required for most categories on most sites. Use ReturnPolicyEnabled in GetCategoryFeatures to determine which categories require this field. To determine which ReturnPolicy fields can be used on each site, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ReturnPolicyDetails</b>. <br> <br> eBay India (IN), Australia (AU), and US eBay Motors Parts and Accessories categories typically support but do not require a return policy. (However, we strongly recommend that you specify a clear return policy whenever possible.)<br> <br> <b>For ReviseItem only:</b> 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.<br> <br> <b>For the GetItem family of calls:</b> 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. MoneyBack AddFixedPriceItem AddItem AddItems AddLiveAuctionItem AddSellingManagerTemplate VerifyAddFixedPriceItem VerifyAddItem Conditionally GetItemRecommendations ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem RelistFixedPriceItem RelistItem VerifyRelistItem MoneyBack No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetBidderList
GranularityLevel: Medium, Fine
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally ReturnPolicy UseTopicAlias (GetCategoryFeatures) Category.ReturnPolicyEnabled categories that require a return policy GetCategoryFeatures.html#Response.Category.ReturnPolicyEnabled (GeteBayDetails) ReturnPolicyDetails return policy fields that each site reports GeteBayDetails.html#Response.ReturnPolicyDetails Enables you to view the sites on which an item can be purchased, based on the payment methods offered for the item. GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always Indicates whether you prefer to track your eBay listings by eBay Item ID or by your own SKU. <br> <br> If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method. <br> <br> If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing.<br> <b>For GetItem and related calls</b>: Only returned when the value is SKU; not returned when the value is ItemID. Not applicable to Half.com. AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem No ItemID GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally eBay Merchant Data API AddFixedPriceItem and ReviseFixedPriceItem http://developer.ebay.com/DevZone/merchant-data/CallRef/index.html Indicates whether the item can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account. A payment gateway account is used by sellers to accept online credit cards (Visa, MasterCard, American Express, and Discover). GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Always GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally GetItems GetSellingManagerTemplates GetSellingManagerSoldListings Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetOrders
DetailLevel: none, ReturnAll
Conditionally Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one order line item can contain multiple items from a single variation.) <br> <br> If you list in two categories, both categories must support listing with variations. See VariationsEnabled in GetCategoryFeatures to determine applicable categories.<br> <br> <b>For ReviseFixedPriceItem and RelistFixedPriceItem:</b> Once a listing has been submitted with variations, you can't delete all the variations when you revise or relist the listing (because it would be considered a different listing). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no purchases, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0.<br> <br> 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.<br> <br> <b>For GetItem and related calls</b> Only returned when a listing has variations. <br><br> <b>For GetSellerList:</b> 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.<br> <br> <b>For GetItemTransactions</b> 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.) <br> <br> <b>For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling:</b> Only returned when a listing has variations and HideVariations was set to false or not specified in the request. Variations UseTopicAlias AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem No VariationQualifications UseTopicAlias GetItem Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetMyeBayBuying LostList WatchList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling ActiveList DeletedFromSoldList DeletedFromUnsoldList ScheduledList SoldList UnsoldList
DetailLevel: none, ReturnAll
Conditionally AddSellingManagerTemplate ReviseSellingManagerTemplate No GetSellingManagerInventory Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally GetItemTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally A list of parts compatibility information specified as name and value pairs. Describes an assembly with which a part is compatible (i.e., compatibility by application). For example, to specify a part's compatibility with a vehicle, the name (search name) would map to standard vehicle characteristics (e.g., Year, Make, Model, Trim, and Engine). The values would desribe the specific vehicle, such as a 2006 Honda Accord. Use the Product Metadata API to retrieve valid search names and corresponding values. <br><br> <b>For the AddItem family of calls:</b> Use this for specifying parts compatibility by application manually. This can only be used in categories that support parts compatibility by application. Use <b class="con">GetCategoryFeatures</b> with the "CompatibilityEnabled" feature ID to determine which categories support parts compatibility by application. <br><br> <span class="tablenote"><b>Note:</b> Only valid parts compatibility name-value pairs will be added to the listing. Any invalid parts compatibility combinations will be reported in the long error message in the response errors with a severity of Warning.</span> <br> <b>For ReviseFixedPriceItem and ReviseItem:</b> 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. <br><br> <b>For GetItem:</b> <b class="con">ItemCompatibilityList</b> is only returned if the seller included item compatibility in the listing and <b class="con">IncludeItemCompatibilityList</b> is set to true in the <b class="con">GetItem</b> request. AddFixedPriceItem AddItem AddItemFromSellingManagerTemplate AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No Product Metadata API Call Reference http://developer.ebay.com/DevZone/product-metadata/CallRef/index.html information on retrieving compatibility search names and corresponding values needed to specify compatibility by application manually PartsCompatibility UseTopicAlias GetItem Conditionally 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). <br><br> Not returned if the item has no specified compatible applications. Not returned if <b class="con">IncludeItemCompatibilityList</b> is specified in the request. <br><br> To retrieve the list of compatibility information, set <b class="con"> IncludeItemCompatibilityList</b> to "true" in the request. GetItem Conditionally The numeric ID (e.g., 1000) for the item condition. Sellers should also clarify the item's condition in their own item description. <br><br> <span class="tablenote"><b>Note:</b> In addition to including notes on flaws or wear and tear on an used item in the <b>Item.Description</b>, and including a <b>ConditionID</b> value, you can provide additional information about the condition of your used item through the <b>Item.ConditionDescription</b> string field. </span> <br> <b>For the AddItem family of calls:</b> Use GetCategoryFeatures for details about which categories support (or require) ConditionID, plus policies and help on choosing the right condition for the item (to reduce disputes). <br> <br> Please note the following behavior if you pass a ConditionID value that is not valid for the category: If ConditionID is disabled (or not applicable) for the category, the item is listed with no condition. If ConditionID is enabled or required for the category, the listing request fails.<br> <br> If you are listing in two categories, the primary category determines which condition model (ConditionID or item specifics) and which condition values can be used. <br> <br> US eBay Motors Parts & Accessories and vehicle categories require ConditionID for new listings and re-listings. <br> <br> Not applicable to Half.com in listing requests (e.g., AddItem). However, ConditionID could be returned in responses for Half.com listings that are available to or sold on the eBay site (as appropriate for the corresponding eBay category).<br> <br> <b>For Revise/Relist calls:</b> In most cases, you can add or modify ConditionID when you revise or relist. If GetCategoryFeatures returns ConditionEnabled=Required for the listing's category, you cannot remove ConditionID from the listing.<br> <br> If an auction has bids or ends within 12 hours, you cannot remove or change its condition, and you cannot replace a condition attribute or custom item specific with ConditionID. In this case, you will still be able to modify other fields that are normally editable, even if ConditionID is not present.<br> <br> In most cases, you can add or modify ConditionID for multi-quantity fixed price listings. (If a multi-quantity fixed price listing has revision restrictions imposed by other choices the seller has made in the listing, you might not be able to remove or change the condition.)<br> <br> If you revise or relist a GTC listing that only has a condition attribute or custom item specific, you need to specify ConditionID (if the category requires it). ReviseInventoryStatus also fails if you attempt to revise listings that are missing ConditionID. (This rule does not apply during auto-renewal of a GTC listing. It only applies when you perform an action on the listing.) <br> <br> <b>For GetItem and GetSellerList:</b> Only returned when the seller specified ConditionID in their listing. Also returns a localized display name.<br> <br> <span class="tablenote"><b>Note:</b> For most categories, eBay does not convert item condition data in the older AttributeSetArray, LookupAttributeArray, or ItemSpecifics format to this format in older listings or when you revise or relist items. This means GTC listings and older ended or sold listings may still return the item condition in these other fields even after new listings only support ConditionID.<br> <br> There are a few categories in which automatic mapping does occur, where the old and newer conditions are identical. See the "Automatic Mapping" tab in the Item Condition Look-up Table link below for details.<br> <br> Also, if you specified ConditionID but the category also supports condition in item specifics, you may receive a "Dropped condition from Item specifics" warning. You can ignore this warning as long as you used ConditionID. </span> ItemCondition UseTopicAlias ConditionValues in GetCategoryFeatures GetCategoryFeatures.html#Response.Category.ConditionValues Item Condition Look-up Table (and Automatic Mapping) http://pages.ebay.com/sellerinformation/news/itemconditionlookup.html AddFixedPriceItem AddItem AddItemFromSellingManagerTemplate AddItems AddSellingManagerTemplate AddLiveAuctionItem RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddFixedPriceItem VerifyAddItem VerifyRelistItem Conditionally GetItem Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally This string field is used by the seller to more clearly describe the condition of items that are not brand new. <br><br> The <b>ConditionDescription</b> 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 <b>ConditionDescription</b> 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. <br><br> This field should only be used to further clarify the condition of the used item. For example, "The right leg of the chair has a small scratch, and on the seat back there is a light blue stain about the shape and size of a coin." It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the item. Make sure that the condition type (<b>Item.ConditionID</b>), condition description, item description (<b>Item.Description</b>), and the listing's pictures do not contradict one another. <br><br> <span class="tablenote"> <strong>Note:</strong> The <b>ConditionDescription</b> field is optional For Add/Revise/Relist API calls. However, this field may become required in some categories starting with the Spring 2013 Seller Release. <br> <b>ConditionDescription</b> is currently supported only on the eBay US, UK and Motors sites. </span> The <b>ConditionDescription</b> field is returned by <b>GetItem</b> (and other related calls that return the Item object) if a condition description is specified in the listing. 1000 AddFixedPriceItem AddItem AddItemFromSellingManagerTemplate AddSellingManagerTemplate AddItems VerifyAddFixedPriceItem VerifyAddItem RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyRelistItem No GetSellerList Conditionally
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Fine, Medium
 GetItem GetItems Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
 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).<br> <br> 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.<br> <br> Behind the scenes, eBay's search engine uses the ID (not the display name) to determine whether items are new, used, or refurbished.<br> <br> Only returned when the seller specified ConditionID in their listing. 50 GetItem Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally 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. AddFixedPriceItem AddItem AddItems RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem VerifyAddFixedPriceItem VerifyAddItem Conditionally GetItem
DetailLevel: ReturnAll
Conditionally Indicates the type of message that will be returned describing the quantity available for the item. GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally 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. 10 GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Conditionally Reserved for future use. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price (MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings and auction listings with the Buy It Now opton. STP is available on the US, UK, and German (DE) sites, while MAP is available only on the US site. <br /> <br /> Discount pricing is available to qualified sellers (and their associated developers) who participate in the Discount Pricing Program. Once qualified, sellers receive a "special account flag" (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation items. Sellers should contact their account manager or Customer Service to see if they qualify for the Strikethrough Pricing program. <br><br> As a seller listing Discount Price items, you are required to maintain records of your discount pricing in the event you are called upon to substantiate your item pricing. The following link details your legal obligations when you utilize Discount Pricing to sell items: <a href= "http://pages.ebay.com/help/sell/strike-through.html">Strikethrough Pricing Requirements </a> <br><br> <b>For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and VerifyAddFixedPriceItem:</b> If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation. DiscountPricing UseTopicAlias AddFixedPriceItem AddItem RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem VerifyAddFixedPriceItem VerifyAddItem VerifyRelistItem No GetItem Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 If true, and the item details in the request match a product in the eBay catalog, the matching product is used to list the item. This is like using ProductListingDetails to list an item. Applies only to catalog-enabled categories. <br><br> This feature is available to a small subset of eBay-selected sellers. <br><br> Not applicable to Half.com. AddFixedPriceItem AddItem RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem VerifyAddItem VerifyRelistItem No Item.ProductListingDetails #Request.Item.ProductListingDetails 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.<br> <br> 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.<br> <br> This replaces the older US and Canada eBay Motors Subtitle attribute (attribute ID 10246).<br> <br> Not applicable to Half.com. 80 AddItem AddItems AddSellingManagerTemplate GetItemRecommendations VerifyAddItem No RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyRelistItem No GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellingManagerTemplates Conditionally Vehicle Identification Number, which is a unique serial number for a motor vehicle.<br> <br> Applicable to listings in US eBay Motors Cars and Trucks (6001), Motorcycles (6024), Commercial Trucks (63732), RVs and Campers (50054), ATVs (6723), Snowmobiles (42595), and UTVs (173665); and to Cars and Trucks listings in CA, CAFR and AU eBay Motors. For vehicle categories that do not use VIN, call GetCategorySpecifics to determine applicable custom item specifics (such as "Hull ID Number" for Boats). <br> <br> For the US, CA, and CAFR eBay Motors sites, required for cars and trucks from model year 1981 and later. (The US developed national standards for VIN values as of 1981.)<br> <br> 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. <br> <br> Appears in the VIN field in the Item Specifics section of eBay's View Item page.<br> <br> Not applicable to Half.com. 17 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations VerifyAddFixedPriceItem VerifyAddItem Conditionally RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyRelistItem No GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellingManagerTemplates Conditionally Link to the Vehicle History Report for the vehicle whose VIN was specified in Item.VIN. If no vehicle history report is available, eBay may instead show a plain-text copy of the VIN.<br> <br> Applicable to listings in US eBay Motors Cars and Trucks, Motorcycle, and some Powersport, Boats and RV campers categories; and to Cars and Trucks listings in CA, CAFR and AU eBay Motors.<br> <br> For the eBay Australia site, only appears on the View Item page if you specify Item.VIN and you also specify the date of first registration in the listing's item specifics.<br> <br> Not applicable to Half.com. 2056 ComingSoon GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally Vehicle Registration Mark, which is a unique identifier for a motor vehicle.<br> <br> Applicable to listings in UK eBay Motors Cars and Trucks, Motorcycle, and some Powersport categories.<br> <br> 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).<br> <br> Not applicable to Half.com. 7 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations VerifyAddItem No RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyRelistItem No GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellingManagerTemplates Conditionally Link to the Vehicle History Report for the vehicle whose VRM was specified in Item.VRM. The report is visible to all users. If no vehicle history report is available, eBay may instead show a plain-text copy of the masked VRM.<br> <br> Applicable to listings in UK eBay Motors Cars and Trucks, Motorcycle, and some Powersport categories.<br> <br> Not applicable to Half.com. 2056 ComingSoon GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally This container is used to set the minimum number of event tickets that should remain available after a buyer makes a purchase. This functionality allows the seller to avoid the possibility of being left with just one event ticket after a sale. <br><br> This container can be used when adding, revising, or relisting event tickets, and it will only be returned in <b>GetItem</b> if set for the listing. AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem No AddItem ReviseItem RelistItem VerifyAddItem VerifyRelistItem No GetItem Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Root container consisting of references to one or more Business Policies profiles. Exactly one Payment Profile, one Shipping Profile, and one Return Policy Profile may be applied to the listing. 6 AddFixedPriceItem AddItem AddItems VerifyAddItem Conditionally RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem No GetItem GetSellerEvents GetItems GetMyeBaySelling GetSellingManagerTemplates GetSellerList Conditionally 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. 6 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate VerifyAddFixedPriceItem VerifyAddItem AddSellingManagerTemplate VerifyAddFixedPriceItem Conditionally RelistFixedPriceItem RelistItem VerifyRelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyRelistItem No GetItem GetSellerEvents GetItems GetMyeBaySelling GetSellingManagerTemplates GetSellerList Conditionally This field applies only to the US site, and will be returned only if the US seller qualifies as a <b>Top-Rated Seller</b>. <br/><br/> If this flag is returned for a listing, it indicates that the listing meets the new requirements for a <b>Top-Rated Plus</b> listing. A <b>Top-Rated Plus</b> listing must meet the following requirements: <ul> <li>14-day (or longer) return policy with Money Back option</li> <li>1-day Handling Time or better</li> </ul> <br/> A <b>Top-Rated Plus</b> seal appears on the View Item page for qualifying listings. </b>Top-Rated Sellers</b> get a 20 percent discount on their Final Value Fee for all listings that qualify as <b>Top-Rated Plus</b>. <br/><br/> See eBay's <a href="http://pages.ebay.com/sellerinformation/sellingresources/toprated.html">Top Rated Seller Resource Center</a> for more information about how to qualify as a Top-Rated Seller. GetItem GetItems Conditionally 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. <br/><br/> This value is only applicable to sellers using the Dynamic Pricing API, and if a dynamic pricing rule is assigned to the listing's product. ReviseItem ReviseFixedPriceItem No