Value-Added Tax (VAT)

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 Allows a seller to create a new Unpaid Item dispute. Can only be used by the seller at least 7 days after the transaction is created, unless the buyer is no longer a registered eBay user or has requested shipment to a country the seller does not ship to. A buyer creates an Item Not Received dispute on the eBay site.

Enables a seller to use an item ID and transaction ID to create a new Unpaid Item dispute.

An explanation of the dispute that supplements the DisputeReason. The allowed value depends on the value of DisputeReason. AddDispute Yes The top-level reason for the Unpaid Item Dispute. DisputeReasonCodeType has several possible values. However, only BuyerHasNotPaid and TransactionMutuallyCanceled apply to AddDispute--you can only use AddDisputeCall to create Unpaid Item disputes. AddDispute Yes The eBay ID of the item in dispute, an item which has been sold but not yet paid for. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddDispute Yes The eBay ID of a transaction, created when the buyer committed to purchasing the item. A transaction ID is unique to the item but not across the entire eBay site. The transaction ID must be combined with an item ID to uniquely identify an item. 10 AddDispute Yes Returned after calling AddDisputeRequest. The response confirms that the Unpaid Item dispute was successfully created. The unique identifier of the Unpaid Item dispute. AddDispute Always Allows a seller to respond to an Unpaid Item or Item Not Received dispute. The response can add a comment or close the dispute.

Adds a response or comment to a dispute, or closes a dispute.

The unique identifier of the dispute, returned when the dispute was created. AddDisputeResponse Yes The text of a comment or response being posted to the dispute. Required when DisputeActivity is SellerAddInformation, SellerComment, or SellerPaymentNotReceived; otherwise, optional. AddDisputeResponse Conditionally The type of activity the seller is taking on the dispute. The allowed value is determined by the current value of DisputeState, returned by GetDispute or GetUserDisputes. Some values are for Unpaid Item disputes and some are for Item Not Received disputes. AddDisputeResponse Conditionally The shipping carrier used for the item in dispute. Required if DisputeActivity is SellerShippedItem; otherwise, optional. AddDisputeResponse Conditionally The shipper's tracking number for the item being shipped. Required if DisputeActivity is SellerShippedItem; otherwise, optional. AddDisputeResponse Conditionally The date the item under dispute was shipped. Required if DisputeActivity is SellerShippedItem; otherwise, optional. AddDisputeResponse Conditionally Returned after taking an action on a dispute with AddDisputeResponseRequest. Includes the status of the request. Defines a single new item and lists it on a specified eBay site. To list multiple new items, execute AddItem once for each item, with a new item definition each time.

Sends data defining a new item (specified by a seller) to eBay, where it becomes a new listing. Returns the item ID for the new listing and estimates fees the seller will incur for the listing (not including the Final Value Fee, which cannot be calculated until the item is sold).

Child elements hold the values that define the new item. Item is a required input. Also applicable to Half.com. AddItem Yes 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. 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. 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. AddItem Conditionally Deprecated Returns the item ID and the estimated fees for the new listing, as well as the start and end times of the listing. Unique item ID for the new listing. Also applicable to Half.com. 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. Also returned for 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. Also returned for Half.com, but 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. Also returned for Half.com, but the values are not applicable to Half.com listings. AddItem 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 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. 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. Not applicable to Half.com. 10 AddItem Conditionally Lists a lot item on the eBay Live Auctions site. The lot item will also be visible to users who search and browse the US eBay.com site. Only authorized eBay Live Auctions sellers can list lot items.

Available to eBay Live Auctions sellers. Sends data defining a single new lot item to the eBay Live Auctions site, where it becomes a new lot in a seller's Live Auction catalog. The listing also appears on the main eBay site. As in the case of AddItem, the data returned includes an item ID for the new listing and estimated fees, not including the Final Value Fee.

Specifies the values that define the new lot item. Item is a required input. AddLiveAuctionItem Yes Returns the item ID and the estimated fees for the new lot item listing, as well as the state of the lot item (e.g., categories that changed). The item ID of the lot. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddLiveAuctionItem 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. For consistency in the response, the call returns the same kinds of fees as other listing calls, but some fees are not applicable to eBay Live Auctions listings. See "Fees Resulting from Listing an Item" in the eBay Web Services guide for information about fees. AddLiveAuctionItem 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 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 AddLiveAuctionItem 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 AddLiveAuctionItem Conditionally Enables a seller to respond to eBay users who have asked questions about an active item listings. To be deprecated in Oct 2006.

Enables a seller to respond to eBay users who have asked questions about an active item listing. To be deprecated in Oct 2006. Use AddMemberMessageRTQ instead.

The unique ID of the item about which the question was asked. Required input for AddMemberMessage MessageType = ResponseToASQQuestion. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddMemberMessage Conditionally The message itself. AddMemberMessage Yes Enables a buyer and seller in a transactional relationship to send messages to each other within 90 days of the creation of the transaction.

Enables a buyer and seller in a transactional relationship to send messages to each other's My Messages Inboxes within 90 days of the creation of the transaction.

The unique ID of the item about which the question was asked. AddMemberMessageAAQToPartner Yes The message itself. AddMemberMessageAAQToPartner Yes Response to AddMemberMessageAAQToPartner request. Enables a seller to reply to a question about an active item listing.

Enables a seller to reply to a question about an active item listing. The reply is sent to the user's My Messages inbox.

The unique ID of the item about which the question was asked. AddMemberMessageRTQ Yes The message itself. AddMemberMessageRTQ Yes Response to AddMemberMessageRTQ request. Enables a seller to send up to 10 messages to bidders and users who have made offers (via Best Offer) during an active listing.

Enables a seller to send up to 10 messages to bidders and users who have made offers (via Best Offer) during an active listing. Messages to a user appear in the user's My Messages inbox.

Allows a seller to send up to 10 messages to bidders and users who have made offers (via Best Offer) during an active listing. AddMemberMessagesAAQToBidder Yes Contains the response information. Contains the response information. AddMemberMessagesAAQToBidder Always Combines two or more transactions into a single order. A transaction is the commitment by a buyer to purchase an item. On a successful call to AddOrder, the multiple transactions are combined into a single order. We strongly recommend that you avoid mixing digital and non-digital listings in the same order. (In the future, AddOrder may enforce this recommendation.)

Combines two or more transactions into a single order. The order has a unique identifier and the buyer can make a single payment for purchases.

The order that is being created. AddOrder Yes Returns a unique identifier for the order. A buyer may make a single payment to purchase all of the item transactions that are included in the order. The unique identifier for the order. AddOrder Always The date and time the order was created. AddOrder Always Creates a new Second Chance Offer listing for an item to one of that item's non-winning bidders.

Creates a new Second Chance Offer (that is, an offer for an unsold item) to a non-winning bidder.

Adds text to the end of the description section of an item listing.

Unique item ID that identifies the target item listing, the description of which is appended with the text specified in Description. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddToItemDescription Yes Specifies the text to append to the end of the listings description. Text appended to a listing's description must abide by the rules applicable to this data (such as no JavaScript) as is the case when first listing the item. AddToItemDescription Yes Indicates the success or failure of the attempt to add text to the end of the description section of an item listing. Adds one or more items to the user's My eBay watch list.

Adds one or more items to the user's My eBay watch list.

The ItemID of the item that is to be added to the watch list. The item must be a currently active item, and the total number of items in the watchlist (after the items in the request have been added) cannot exceed the maximum allowed number of watch list items. One or more ItemIDs can be specified, each in its own ItemID container. A separate error node will be returned for each item that fails. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddToWatchList Yes The number of items in the user's watch list (after those specified in the call request have been added) AddToWatchList Always The maximum number of items allowed in watch lists. Currently this value is the same for all sites and all users. AddToWatchList Always Ends the listing specified by ItemID and creates a new Transaction Confirmation Request (TCR) for an item. A TCR enables a buyer to purchase an item. Applies to the US eBay Motors site (except Parts and Accessories category), effective in early July 2006. You can use this call for an item after the item has been listed for at least 24 hours. A TCR is sent by a seller to one of the following: a bidder, a best offer buyer, a member with an ASQ question, or any member with a postal code. Alternatively, this call can be used to verify that a new TCR can be created.

Ends the listing specified by ItemID and creates a new Transaction Confirmation Request (TCR) for an item.

Specifies the user to whom the seller is offering the Transaction Confirmation Request. AddTransactionConfirmationItem Yes If true, specifies that the seller is verifying whether a new Transaction Confirmation Request (TCR) can be created. Thus, if this value is passed as true, then no Transaction Confirmation Request is actually made. If VerifyEligibilityOnly is not passed, or is false, a Transaction Confirmation Request is actually made. AddTransactionConfirmationItem No Specifies the postal code of the user to whom the seller is offering the Transaction Confirmation Request. Required only if the user does not meet the other options listed in RecipientRelationCodeType. An error is returned if RecipientUserID and RecipientPostalCode do not match for more than 3 times for a seller per day. AddTransactionConfirmationItem No Specifies the current relationship between the seller and the potential buyer. A seller can make a Transaction Confirmation Request (TCR) for an item to a potential buyer if the buyer meets one of several criteria. A TCR is sent by a seller to one of the following: a bidder, a best offer buyer, a member with an ASQ question, or any member with a postal code. See the values and annotations in RecipientRelationCodeType. AddTransactionConfirmationItem Yes The amount the offer recipient must pay to buy the item specified in the Transaction Confirmation Request (TCR). A negotiated amount between the buyer and the seller. AddTransactionConfirmationItem Yes Specifies the length of time the item in the Transaction Confirmation Request (TCR) will be available for purchase. AddTransactionConfirmationItem Yes The ItemID of the item that the seller wants to end in order to create a Transaction Confirmation Request (TCR). AddTransactionConfirmationItem Yes Comments the seller wants to send to the recipient (bidder, best offer buyer, member with an ASQ question, or member with a postal code). AddTransactionConfirmationItem No Returns an item ID for a new Transaction Confirmation Request (TCR). The new item ID for the item in the new Transaction Confirmation Request (TCR). This field is not returned if the request was only used to verify that a new TCR could be created. AddTransactionConfirmationItem Conditionally The date and time when the item in the new Transaction Confirmation Request (TCR) becomes available for purchase. AddTransactionConfirmationItem Always The date and time when the item in the new Transaction Confirmation Request (TCR) is no longer available for purchase. AddTransactionConfirmationItem Always Provides Live Auction sellers with the ability to approve, decline, and set the bidding limit of the bidders that have signed up for a catalog. Includes the list of bidders for the requested item as part of the general item listing data.

Provides Live Auction sellers with the ability to approve, decline, and set the bidding limit of the bidders that have signed up for a catalog.

Number that identifies the seller's eBay Live Auctions catalog for which they want to set bidding limits and approve or decline bidders. ApproveLiveAuctionBidders Yes Approval details for a specific set of bidders. ApproveLiveAuctionBidders No This will approve all bidders in the catalog in the pending status only. This is an optional field. If provided and set to true, do not send BidApproval. ApproveLiveAuctionBidders No This is the amount that bidders are beings approved for. This is required if user has set ApproveAllPending to true. It only applies to bidder requests that are in pending status. ApproveLiveAuctionBidders Conditionally Provides the Live Auction sellers with the ability to approve, decline, and set the bidding limit of the bidders that have signed up for a catalog. Contains the results of the request for each item. Mulitple bidders can be approved with one call. ApproveLiveAuctionBidders Always Enables a seller to do various tasks after processing a transaction. The seller can leave feedback for the buyer, change the paid status in My eBay, and/or change the shipped status in My eBay. Only the seller who listed the item can perform these tasks. This call can be executed at any time after a transaction has been created. However, it is a good idea to wait until the sale is complete before using this call.

Enables a seller to do the following tasks after processing a transaction: leave feedback for the buyer, change the paid status in My eBay, or change the shipped status in My eBay (or any combination of these).

ID of the listing associated with the transaction that the seller is completing. Required. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) CompleteSale Yes Unique identifier for a transaction from the listing indicated by ItemID. Call GetItemTransactions or GetSellerTransactions to determine the appropriate transaction ID. Required for all listing types (pass 0 for Chinese auctions). 10 CompleteSale Yes Specifies feedback the seller is leaving for the buyer. For a given transaction, the seller can leave feedback once, and no further modifications can be made to that feedback entry. If feedback has already been left, FeedbackInfo is not allowed. Call GetFeedback to determine whether feedback has already been left. Optional. CompleteSale No If true, the transaction is marked as shipped in My eBay (applicable for Selling Manager Pro users). If false, the transaction is marked as not shipped in My eBay. If not specified, the shipped status in My eBay is not modified. CompleteSale No If true, the transaction is marked as paid in My eBay. If false, the transaction is marked as not paid in My eBay. If not specified, the paid status in My eBay is not modified. Optional. CompleteSale No Indicates the success or failure of the attempt to leave feedback for the buyer, change the paid status in My eBay, and/or change the shipped status in My eBay. Removes selected alerts and messages for a given user. Alerts that require action and have not been resolved by the user cannot be deleted.

Removes selected alerts and messages for a given user.

Contains a list of up to 10 AlertID values. DeleteMyMessages No Contains a list of up to 10 MessageID values. DeleteMyMessages No The response to DeleteMyMessagesRequestType. If the request was successful, DeleteMyMessages returns nothing. Ends the specified item listing. Used by a seller to end the listing before it would normally end, such as before the specified duration has passed or the item was purchased via a Buy It Now option. Only the item's seller may call EndItem to end the item listing. Applicable to items listed on eBay.com and Half.com. For eBay Live Auctions, you cannot delete items that have been closed or that are part of a Live Auction event that has started.

Ends the specified item listing before the date and time at which it would normally end (per the listing duration). For competitive-bidding listings that have bids on them, the listing ends as a successful auction with winning bidder(s) unless the seller first cancels the bids.

Unique item ID that identifies the item listing to end. Also applicable to Half.com. For Half.com listings, you can either specify ItemID or SellerInventoryID. For eBay Live Auctions, you cannot delete items that have been closed or that are part of a Live Auction event that has started. 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. Also applicable to Half.com. EndItem Conditionally 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). Only applicable 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 Retrieves an authentication token for the user. Can be used to get the token only after the user gives consent for the token to be generated via the eBay signin page. This call must be authenticated using the username and password of the application, rather than a token. After retrieval, the token can be used to authenticate other calls.

Retrieves an authentication token for the user.

Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth A value that is associated with the token retrieval request. The secret ID is a value that is defined by the application, and is passed in redirect URL to the eBay signin page. eBay recommends using a UUID for the secret ID value. You must also set Username (part of the RequesterCredentials) for the particular user of interest. FetchToken Yes Includes the authentication token for the user and the date it expires. The authentication token for the user. FetchToken Always Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Date and time at which the token returned in eBayAuthToken expires and can no longer be used to authenticate the user for that application. FetchToken Always Enables a seller to retreive his or her own account data. Returns account entries, including credits and debits, in a report format the user selects. Also returns summary data for the account.

Enables a seller to retreive his or her own account data.

Specifies the report format in which to return account entries. GetAccount Conditionally Specifies the month and year of the invoice requested. The report includes only the entries that appear on the seller's invoice in the specified month and year. An entry can occur in one month and appear on the next month's invoice. Used with SpecifiedInvoice reports. GetAccount Conditionally Specifies the beginning of a date range during which a credit or debit occurred. Used when AccountHistorySelection is BetweenSpecifiedDates. Value must be less than or equal to the value specified in EndDate. The allowed date formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss. GetAccount Conditionally Specifies the end of a date range during which a credit or debit occurred. Used when AccountHistorySelection is BetweenSpecifiedDates. Value must be greater than or equal to the value specified in BeginDate. The allowed date formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss. GetAccount Conditionally Controls pagination of the response. For this request, the valid values of Pagination.EntriesPerPage are 0 to 2000, with a default of 500. GetAccount No Specifies whether to calculate balances. Default is false, which calculates balances. The value true means do not calculate balances. If true, AccountEntry.Balance and AccountSummary.CurrentBalance are never returned in the response. GetAccount No Specifies whether to return account summary information in an AccountSummary node. Default is true, to return AccountSummary. GetAccount No Specifies how account entries should be sorted in the response, by an element and then in ascending or descending order. GetAccount No Specifies the currency used in the account report. Do not specify Currency in the request unless the following conditions are met. First, the user has or had multiple accounts under the same UserID. Second, the account identified in the request uses the currency you specify in the request. An error is returned if no account is found that uses the currency you specify in the request. GetAccount No Returns information about an eBay seller's own account. Specifies the seller's unique account number. GetAccount Always Contains summary data for the seller's account, such as the overall balance, bank account and credit card information, and amount and date of any past due balances. Can also contain data for one or more additional accounts, if the user has changed country of residence. GetAccount Conditionally Indicates the currency used for monetary amounts in the report. GetAccount Always Contains individual account entries, according to the report's scope and date range. Each account entry represents one credit, debit, or administrative account action. GetAccount Conditionally Contains the total number of pages (TotalNumberOfPages) and the total number of account entries (TotalNumberOfEntries) that can be returned on repeated calls with the same format and report criteria. GetAccount Always Indicates whether there are more items yet to be retrieved. Additional calls must be made to retrieve those items. GetAccount Conditionally Specifies the number of items that are being returned per virtual page of date. Value is the same as that specified in Pagination.EntriesPerPage. GetAccount Always Indicates which page of data was just returned. Value is the same as the value specified in Pagination.PageNumber. If PageNumber in the request is higher than the total number of pages, the call fails with an error.) GetAccount Always Retrieve sales lead information for a real estate advertisement listing. GetAdFormatLeadsRequest returns the number of leads for an ad and any contact information that the buyer submitted.

Retrieve sales lead information for a real estate advertisement listing.

The unique identifier of an item listed on the eBay site. Returned by eBay when the item is created. This ID must correspond to an ad format item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetAdFormatLeads Yes (out) Returns number of leads and contact and other information for each lead. One AdFormatLead node is returned for each lead. (out) Contains contact and other information for one lead. One node is returned for each lead. Only returned at a detail level of ReturnAll. At least one lead must be available for the specified item to return AdFormatLead. GetAdFormatLeads Conditionally (out) The total number of leads returned. Only returned if you do not specify a detail level. GetAdFormatLeads Conditionally Includes the list of bidders for the requested item as part of the general item listing data.

Provides three modes for retrieving a list of the users that bid on a listing. One of the modes is of particular value in support of the Second Chance Offer feature. Includes the list of bidders for the requested item as part of the general item listing data.

Extending a Second Chance Offer http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExtendingSecondChanceOffer detailed information on working with the result set The item ID for which to retrieve the list of bidders. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetAllBidders Yes Specifies which bidder information to return. GetAllBidders Yes Includes the list of bidders for the requested item as part of the general item listing data. Contains a list of OfferType objects. Each OfferType object represents the data for one bidder and bid. GetAllBidders Always eBay user ID for the user with the highest bid (or the earliest timestamp, in the event of a tie); a second chance off candidate. GetAllBidders Always Bid amount offered by the HighBidder. GetAllBidders Always Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., winning bidder) and other information. This processing can take several minutes. If you retrieve a sold item, use this listing status information to determine whether eBay has finished processing the listing so that you can be sure the winning bidder and other details are correct and complete. GetAllBidders Always Requests the rules for accessing eBay API calls and your application's daily, hourly, and periodic usage of each call.

Requests the rules for accessing eBay API calls and your application's daily, hourly, and periodic usage of each call.

Returns a list of API access rules, in response to a GetApiAccessRulesRequest. Contains the description of an API access rule, including the call name, the application's current daily and hourly usage, and other values. GetApiAccessRules Always Retrieves an XML string that describes how to present Item Specifics to a seller. Use this information to present users with the equivalent of the Item Specifics portion of the eBay Title and Description pages and to validate selected eBay attributes on the client before including them in an AddItem call or related calls. The XML string contains a list of all the attributes that are applicable for one or more requested categories, along with related meta-data. The meta-data specifies all the possible values of each attribute, the logic for presenting the attributes to a user, and rules for validating the user's selections. See the Developer's Guide for an overview of Item Specifics and details about the eBay attribute model.

Retrieves an XML string that describes how to present Item Specifics to a seller. Item Specifics are optional when listing in most categories; however, some categories (such as Real Estate, US Tickets, and US eBay Motors) require Item Specifics to be specified.

A version of the Item Specifics meta-data definitions for the site. Typically, an application passes the version value that was returned the last time the application executed this call. Filter that causes the call to return only the characteristics sets for which the attribute meta-data has changed since the specified version. If not specified, all characteristics sets are returned. The latest version value is not necessarily greater than the previous value that was returned. Therefore, when comparing versions, only compare whether the value has changed. GetAttributesCS No An array of characteristic setIDs (which always correspond to attribute set IDs). Each characteristic setcorresponds to a level in the eBay category hierarchy at which all items share common characteristics. Multiple categories can be mapped to the same characteristics set. AttributeSetIDs is an optional input. When IDs are specified, the call only returns meta-data for the corresponding characteristics sets. When no IDs are specified, the call returns all the current meta-data in the system. GetAttributesCS No If true, includes a list of CategoryMapping nodes in the response. Each CategoryMapping node specifies category information as well as attributes and values that your application can auto-fill for items listed in that category. See the eBay Web Services Guide for more information about options for maintaining category data and auto-filling Item Specifics. GetAttributesCS No If true, the characteristic set data is customized for digitally delivered items. In the digital delivery variation of the response, there are no changes to the attribute set IDs, attribute IDs, or value IDs, but "return policy" text is replaced with "refund policy" text and the Item Condition attribute is removed from all applicable characteristic sets. If a seller specifies that they are listing a digital item, you can render this variation of the applicable meta-data in your Item Specifics or Return Policy form. (You can use the Item Specifics SYI XSL stylesheet to render the data as usual.) Usage of this information is optional. GetAttributesCS No Returns XML that describes how to present Item Specifics to a seller and how to validate selected eBay attributes on the client before including them in an AddItem call or related calls. See the Developer's Guide for an overview of Item Specifics and details about the eBay attribute model. Also returns the current version of the meta-data system. Current version of the Item Specifics meta-data system for the site. This value changes each time changes are made to the meta-data. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. GetAttributesCS Always A string containing a list of all the attributes that are applicable to the site (or characteristic sets in the request), along with related meta-data. The meta-data specifies all the possible values of each attribute, the logic for presenting attributes to a user, and rules for validating the user's selections. This data is in the same XML format that was used in the Legacy XML API so that you can apply the same Item Specifics XSL stylesheet and your own patching stylesheets to it. That is, individual elements are not described using the new eBay XML schema format. For information about each element in the AttributeData string, see the attribute model documentation in the eBay Web Services guide (see links below). Because this is returned as a string, the XML markup elements are escaped with character entity references (e.g.,&lt;eBay&gt;&lt;Attributes&gt;...). See the appendices in the eBay Web Services guide for general information about string data types. GetAttributesCS Always The Attribute Meta-Data Model http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrModel Retrieves the Item Specifics SYI XSL stylesheet. Apply the stylesheet to the XML returned from a call to GetAttributesCS or GetProductSellingPages to render a form like the Item Specifics portion of eBay's Title and Description page. See the eBay Web Services Guide for an overview of Item Specifics and information on working with the XSL.

Retrieves the Item Specifics SYI XSL stylesheet for use with the GetAttributesCS and GetProductSellingPages response. You use the stylesheet to render Item Specifics in a user interface, as applicable within a particular category.

The name of the XSL file to retrieve. If not specified, the call returns the latest versions of all available XSL files. FileName is an optional input. Valid values syi_attributes.xsl GetAttributesXSL No The desired version of the XSL file. Required if FileName is specified. If not specified, the call returns the latest version of the file. (This is not a filter for retrieving changes to the XSL file.) GetAttributesXSL Conditionally Retrieves the Item Specifics SYI XSL stylesheet.Apply the stylesheet to the XML returned from a call to GetAttributesCS or GetProductSellingPages to render a form like the Item Specifics portion of eBay's Title and Description page. See the Developer's Guide for an overview of Item Specifics and information on working with the XSL. Child elements contain data related to one XSL file. Multiple XSLFile objects can be returned. However, currently only one is returned. GetAttributesXSL Always none, ReturnAll Retrieves the best offers associated with ItemID according to the BestOfferStatus filter, where Active is the default.

Retrieves the best offers associated with ItemID according to the BestOfferStatus filter, where Active is the default.

The item for which Best Offer information is to be returned. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetBestOffers Yes The specific Best Offer for which details are to be retrieved. Omit this tag to get a list of all best offers (according to BestOfferStatus). GetBestOffers No A filter determining which Best Offers to return for an item. Active is the default. GetBestOffers No All best offers for the item according to the filter or best offer id (or both) used in the input. For the notification client usage, this response includes a single Best Offer. All best offers for the item according to the filter or best offer id (or both) used in the input. The buyer and seller messages are returned only if the detail level is defined. Includes the buyer and seller message only if detail level ReturnAll is used. Only returned if best offers have been made. GetBestOffers Always The item for which Best Offers are being returned. Only returned if best offers have been made. GetBestOffers Always Retrieves all items on which the user is currently bidding or which the buyer has won or purchased.

Retrieves all items on which the user is currently bidding or which the buyer has won or purchased.

Retrieves all items on which the user is currently bidding or which the buyer has won or purchased. Indicates whether to limit the result set to active items. If true, only active items are returned and the EndTimeFrom and EndTimeTo filters are ignored. If false (or not sent), active and ended items are returned. GetBidderList No Limits returned items to only those for which the item's end date is on or after the date-time specified. Specify an end date within 30 days prior to today. Items that ended more than 30 days ago are omitted from the results. If specified, EndTimeTo must also be specified. Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. (For information on how to convert between your local time zone and GMT, see Time Values Note.) This field is ignored if ActiveItemsOnly is true. GetBidderList Conditionally Limits returned items to only those for which the item's end date is on or before the date-time specified. If specified, EndTimeFrom must also be specified. Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. This field is ignored if ActiveItemsOnly is true. GetBidderList Conditionally The user for whom information should be returned. If provided, overrides user defined via RequesterCredentials in header. GetBidderList No For GetBidderList, you can reduce the ItemType fields and other fields returned by specifying one of two values in the GranularityLevel field, Coarse or Medium. If you specify Coarse, the primary fields returned are the following: Item.ItemID and Item.ListingDetails.EndTime. If you specify Medium, an abbreviated result set is returned that includes many more fields than in the case of Coarse, including the following: Item.BuyItNowPrice, Item.Currency, Item.Site, and Item.Title. GetBidderList No Response to GetBidderListRequest. Response to GetBidderListRequest. Data for one eBay bidder. GetBidderList Always Array of items the bidder has bid on, has won or has lost. GetBidderList Always Contains the inputs that determine which categories to return and from which eBay site to get them. Retrieves the category hierarchy including and under the category (or categories) specified in CategoryParent.

Retrieves from eBay the latest category hierarchy. Information returned for each category includes the category name and the unique identifier for the category (unique within the eBay site for which categories are retrieved). A category ID is a required input for most new items.

dl Specifies the eBay site for which to retrieve the category hierarchy. Use the numeric site code (e.g., 77 for eBay Germany). Only necessary if you want to retrieve category data for a site other than the site to which you are submitting the request. GetCategories No The site ID of the request Specifies the ID of the highest-level category to return, along with its subcategories. If no parent category is specified, all categories are returned for the specified site. To determine available category IDs, call GetCategories with no filters and use a DetailLevel value of ReturnAll. If you specify multiple parent categories, the hierarchy for each one is returned. GetCategories No 0 Specifies the maximum depth of the category hierarchy to retrieve, where the top-level categories (meta-categories) are at level 1. Retrieves all category nodes with a category level less than or equal to this value. If not specified, then categories at all applicable levels can be returned. As with all calls, the actual data returned will vary depending on how you configure other fields in the request (inicluding the DetailLevel). GetCategories No 0 If false or omitted, only leaf categories are returned. (You can only list in leaf categories.) If true, both leaf and internal (non-leaf) categories are returned. As with all calls, the actual data returned will vary depending on how you configure other fields in the request. GetCategories No false Contains the category data for the eBay site specified as input. The category data is contained in a CategoryArrayType object, within which are zero, one, or multiple CategoryType objects. Each CategoryType object contains the detail data for one category. Other fields tell how many categories are returned in a call, when the category hierarchy was last updated, and the version of the category hierarchy (all three of which can differ from one eBay site to the next). List of the returned categories. The category array contains one CategoryType object for each returned category. Returns empty if no detail level is specified. GetCategories Always ReturnAll Indicates the number of categories returned (i.e., the number of CategoryType objects in CategoryArray). GetCategories Always ReturnAll Indicates the last date and time that eBay modified the category hierarchy for the specified eBay site. GetCategories Always ReturnAll, none Indicates the version of the category hierarchy on the specified eBay site. GetCategories Always ReturnAll, none The ReservePriceInclusive and ReduceReserveInclusive fields will be deprecated in a future release. We recommend that you start using ReduceReserveAllowed and ReservePriceAllowed instead of these "inclusive" fields as soon as possible. The names of ReservePriceInclusive and ReduceReserveInclusive are REVERSED. If true, ReservePriceInclusive indicates that all categories on the site allow the seller to REDUCE an item's reserve price. If false, all categories on the site do not normally allow sellers to reduce an item's reserve price. The Category.ORRA (override reduce reserve price) field can override (or toggle) the reserve price reduction setting for a given category. For example, if ReservePriceInclusive is false and Category.ORRA is true, the category overrides the site setting and supports reducing reserve prices. If ReservePriceInclusive is true and Category.ORRA is true, the category overrides the site setting and does does not support reducing reserve prices. GetCategories Always Deprecated ReturnAll, none If true, ReservePriceAllowed indicates that all categories on the site allow the seller to specify a reserve price for an item. If false, all categories on the site do not normally allow sellers to specify reserve prices. The Category.ORPA (override reserve price allowed) field can override (or toggle) the reserve price allowed setting for a given category. For example, if ReservePriceAllowed is false and Category.ORPA is true, the category overrides the site setting and supports reserve prices. If ReservePriceAllowed is true and Category.ORPA is true, the category overrides the site setting and does does not support reserve prices. GetCategories Always ReturnAll, none Indicates the lowest possible reserve price allowed for any item listed in any category on the site. You can use the fields returned by GetCategoryFeatures to determine if a different Minimum Reserve Price is defined for the category you want to use. GetCategories Always ReturnAll, none Not used. GetCategories Conditionally Obsolete The ReservePriceInclusive and ReduceReserveInclusive fields will be deprecated in a future release. We recommend that you start using ReduceReserveAllowed and ReservePriceAllowed instead of these "inclusive" fields as soon as possible. The names of ReservePriceInclusive and ReduceReserveInclusive are REVERSED. If true, ReduceReserveInclusive indicates that all categories on the site allow the seller to SPECIFY a reserve price for an item. If false, all categories on the site do not normally allow sellers to specify reserve prices. The Category.ORPA (override reserve price allowed) field can override (or toggle) the reserve price inclusive setting for a given category. For example, if ReduceReserveInclusive is false and Category.ORPA is true, the category overrides the site setting and supports reserve prices. If ReduceReserveInclusive is true and Category.ORPA is true, the category overrides the site setting and does does not support reserve prices. GetCategories Always Deprecated ReturnAll, none If true, ReduceReserveAllowed indicates that all categories on the site allow the seller to reduce an item's reserve price. If false, all categories on the site do not normally allow sellers to reduce an item's reserve price. The Category.ORRA (override reduce reserve price) field can override (or toggle) the reserve price reduction setting for a given category. For example, if ReduceReserveAllowed is false and Category.ORRA is true, the category overrides the site setting and supports reducing reserve prices. If ReduceReserveAllowed is true and Category.ORRA is true, the category overrides the site setting and does does not support reducing reserve prices. GetCategories Always ReturnAll, none Retrieves mappings between categories and characteristics sets that are available for an eBay site. Retrieves all mappings or just those that match category IDs passed in the call.

Retrieves mappings between categories and characteristics sets that are available for an eBay site.

ID of a category for which to retrieve mappings. If not specified, the call retrieves a map for all categories. 10 GetCategory2CS No A version of the mappings for the site. Typically, an application passes the version value that was returned the last time the application executed this call. Filter that causes the call to return only the categories for which the mappings have changed since the specified version. If not specified, all category-to-characteristics set mappings are returned. This value changes each time changes are made to the mappings. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. GetCategory2CS No Returns data that indicates the categories that are mapped to characteristics sets, for the eBay site to which the call was routed. Retrieves all mappings or just the one that matches the category ID passed as input. The data is returned in a CategoryArrayType object, which can contain multiple mappings. The response also contains information about categories for which the mappings have changed. Note: The Pre-filled Item Information feature depends on the Item Specifics feature. This means the set of catalog-enabled categories is a subset of the categories that are mapped to characteristic sets. That is, there are no catalog-enabled categories that are not mapped to characteristic sets. Contains data about categories that are mapped to characteristics sets. Use this data to determine: - The names and IDs of the characteristics sets - The availability of the Pre-filled Item Information feature for listings in that category (i.e., whether the category is catalog-enabled) - For catalog-enabled categories, the available product search methods - The current version information for the complete mapping - The version information for each characteristics set GetCategory2CS Conditionally Contains data about categories (if any) whose characteristics set mappings have changed since the version specified in the request. When a characteristics set mapping changes, the data appears in both the UnmappedCategoryArray object (to indicate that the change occurred) and the MappedCategoryArray object. GetCategory2CS Conditionally Current version of the mappings for the site. This value changes each time changes are made to the mappings. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. GetCategory2CS Always A list of one or more characteristics sets mapped to the category, if any. Use this information when working with Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) functionality. GetCategory2CS Conditionally Retrieves the promotional financing offers available in a specified category

Retrieves the promotional financing offers available in a specified category.

dl Retrieve the promotional financing offers for this category. 10 GetCategory2FinanceOffer No Date from which to retrieve financing offers. GetCategory2FinanceOffer No Contains either the set of finance offers for a given category, or the number of finance offers for a given category. Number of finance offers that apply to the specified category. GetCategory2FinanceOffer none, ReturnAll Always Set of finance offers that apply to the specified category. GetCategory2FinanceOffer ReturnAll Always Returns the categories on the site that have the features you requested in FeatureDefinitions. The return set might have fewer categories than the site has defined, because only some categories implement those features.

Returns information about features that may only be applicable to certain categories on the site, such as particular listing durations, shipping term requirements, and Best Offer features.

dl Defines the category for which you want information. If not specified, returns all categories for the site. 10 GetCategoryFeatures No Specifies the levels of categories to return. By specifying a value in LevelLimit, you retrieve all category nodes with a CategoryLevel less than or equal to the LevelLimit value. GetCategoryFeatures No Specifies, when false or not specified, that just leaf category nodes be returned. When true, all applicable category nodes are returned. GetCategoryFeatures No false Identifies the feature you want information about. If no value is specified, the value defaults to all feature IDs. GetCategoryFeatures No Returns the categories on the site that have the features you requested in FeatureIds. The return set might have fewer categories than the site has defined, because only some categories implement those features. GetCategoryFeatures none, ReturnSummary, ReturnAll Always Gives the time in GMT that the category hierarchy was last updated. GetCategoryFeatures none, ReturnSummary, ReturnAll Always Lists the categories on the site that have the features you requested in FeatureID. The return set might have fewer categories than the site has defined, because only some categories implement those features. GetCategoryFeatures ReturnAll Conditionally Returns feature definitions defined for the entire site. Each feature has a node in this section. GetCategoryFeatures ReturnAll Always Returns definitions and values for the various features you requested. Each feature has a node within FeatureDefinitions. GetCategoryFeatures none, ReturnSummary, ReturnAll Always Returns items in a specified category.

Returns items in a specified category. A number of inputs are provided for filtering the item listings returned using such criteria as location, whether the item is listed in an ebay Store, the listing type, and including or excluding specified sellers.

Filters the response based on each item's eligibility to appear on the mobile.de site. If false, excludes eligible items from search results. If true, queries for eligible items only. If not specified, the search results are not affected. Only applicable for items listed on the eBay Germany site (site ID 77) in subcategories of mobile.de search-enabled categories. GetCategoryListings No Specifies the category for which to retrieve item listings. 10 GetCategoryListings Yes Reserved for future use. GetCategoryListings No Numeric ID for a currency type. Limits the result set to just those items listed using a specified currency. Not applicable to US eBay Motors searches. GetCategoryListings No Filters items based on the ListingType set for the items. If you search for Store Inventory items, you should use values in ItemTypeFilter instead of StoresFixedPrice. If ItemTypeFilter is not specified (or if the AllItemTypes value of ItemTypeFilter is specified), all listing types can be returned unless another relevant filter is specified. GetCategoryListings No Ignored if Store-related values in ItemTypeFilterCodeType are used as input filters. Using values in ItemTypeFilterCodeType is preferable to using StoresFixedPrice. StoresFixedPrice controls whether or not to use Store Inventory format as a filtering criterion. If true, the results only include Store Inventory listings (with no listings in other formats). If false, the results only include listings in other formats (with no Store Inventory listings). If not specified (the default), this filter is not applied at all, so all formats can be returned. If you do not sort the results, Store Inventory listings normally appear after all matching auction and basic fixed price listings (for eBay sites that default to sorting by items ending soonest). If you pass StoresFixedPrice in the same request with ItemTypeFilter, "AND" logic may be applied, and you might not get the desired results. For example, if you specify StoresFixedPrice=true and ItemTypeFilter=AuctionItemsOnly, the call will succeed but no listings will be returned (because no listings can use both auction and Store Inventory formats). This is why it is recommended that you use values in ItemTypeFilterCodeType instead of StoresFixedPrice. GetCategoryListings No ObsoleteSoon Specifies whether to limit the item listings to just those that are category featured or super featured or all items. GetCategoryListings No Specifies the order in which the item listings returned will be sorted. Store Inventory listings are usually returned after other listing types, regardless of the sort order. GetCategoryListings No Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and which page of data to return. GetCategoryListings No Limits the result set to just those items that meet location criteria: listed in a specified eBay site, location where the seller has the item, location from which the user is searching, and/or items listed with a specified currency. GetCategoryListings No Limits the result set to just those items that meet proximity search criteria: postal code and max distance. GetCategoryListings No (in) When passed with a value of 1 (true), only Get It Fast listings are returned. Controls the set of listings to return (not the details to return for each listing). Specifies items that accept a specific payment method or methods. GetCategoryListings No For eBay Germany only. If true, each item in the result set can also include the item condition attribute (whether the item is new or used). The item's condition is returned in Item.AttributeSetArray. An item only includes condition attribute if the item's seller filled in the Item Condition in the Item Specifics section of the listing. (That is, the condition attribute is not returned if the seller only put the word "New" in the listing's title but did not specify the condition in the listing's Item Specifics.) GetCategoryListings No If true, each item in the result set also includes information about the seller's feedback. GetCategoryListings No Include local items in returning results near this postal code. This postal code is the basis for local search. GetCategoryListings No Contains the item listings for the specified category and which meet the input filtering criteria (if any is specified). Consists of one ItemType object for each returned item listing. GetCategoryListings Conditionally Indicates the category from which the listings were drawn. GetCategoryListings Always Collection of the sub-categories that are child to the category indicated in Category. Data for each sub-category is conveyed in a CategoryType object. GetCategoryListings Conditionally Indicates the maximum number of item listings that will be returned per call. GetCategoryListings Always Indicates the page of data returned in the current call. GetCategoryListings Always Indicates whether there are more item listings that can be returned (items listed in the specified category and that meet any input filtering criteria). GetCategoryListings Always Indicates the results of the pagination, including the total number of pages of data there are to be returned and the total number of items there are to be returned. GetCategoryListings Always Contains information about relevant buying guides (if any) and the site's buying guide hub. Buying guides are useful to buyers who do not have a specific product in mind. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. GetCategoryListings Conditionally Retrieves a map of old category IDs and corresponding active category IDs defined for the site to which the request is sent. Typically used to update an older item definition with a new category ID prior to listing the item.

Retrieves a map of old category IDs and corresponding active category IDs defined for the site to which the request is sent.

A version of the category mapping for the site. Filters out data from the call to return only the category mappings for which the data has changed since the specified version. If not specified, all category mappings are returned. Typically, an application passes the version value of the last set of category mappings that the application stored locally. The latest version value is not necessarily greater than the previous value that was returned. Therefore, when comparing versions, only compare whether the value has changed. GetCategoryMappings No Returns a map of old category IDs and corresponding active category IDs defined for the site to which the request was sent. Typically used to update an older item definition with a new category ID prior to listing the item. Mapping between an old category ID and an active category ID. Returned when category mappings exist and the value of CategoryVersion is different from the current version on the site. GetCategoryMappings Conditionally ReturnAll Version value assigned to the current category mapping data for the site. Compare this value to the version value the application stored with the mappings the last time the application executed the call. If the versions are the same, the data has not changed since the last time the data was retrieved and stored. GetCategoryMappings Always none, ReturnAll Searches for nonprofit charity organizations that meet the criteria specified in the request.

Searches for nonprofit charity organizations that meet the criteria specified in the request.

A unique identification number assigned by eBay to registered nonprofit charity organizations. GetCharities No A name assigned to a specified nonprofit organization. Accepts full charity nonprofit name or partial name as input. For example, enter a CharityName of "heart" (case-insensitive) to return all charity nonprofits that start with "heart." Use with a MatchType value of "Contains" to return all charity nonprofits that contain the string "heart." 150 GetCharities No Accepts a case-insensitive string used to find a nonprofit charity organization. Default behavior is to search the CharityName field. Use with an IncludeDescription value of true to include the Mission field in the search. 350 (characters) GetCharities No Region that the nonprofit charity organization is associated with. A specific nonprofit charity organization may be associated with only one region. Meaning of input values differs depending on the site. See GetCharities in the API Developer's Guide for the meaning of each input/output value. CharityRegion input value must be valid for that SiteID. GetCharities No Domain (mission area) that a nonprofit charity organization belongs to. Nonprofit charity organizations may belong to multiple mission areas. Meaning of input values differs depending on the site. See GetCharities in the API Developer's Guide for the meaning of each input/output value. CharityDomain input value must be valid for that SiteID. GetCharities No Used with Query to search for charity nonprofit organizations. A value of true will search the Mission field as well as the CharityName field for a string specified in Query. GetCharities No Indicates the type of string matching to use when a value is submitted in CharityName. If no value is specified, default behavior is "StartsWith." Does not apply to Query. GetCharities No Contains information about charity nonprofit organizations that meet the criteria specified in the request. Contains information about charity nonprofit organizations that meet the criteria specified in the request. One Charity node is returned for each applicable nonprofit charity organization. The CharityID value is returned as an id attribute of this node. If no nonprofit charity organization is applicable, this node is not returned. GetCharities Conditionally Retrieves top-ranked contextual eBay keywords and categories for a specified web page. Results are ranked according to score. This enables developers to create applications that are different from traditional contextual ad serving. For instance, instead of building a standard ad banner or skyscraper ad like those from eBay AdContext, a developer could create an application that does inline hyperlinking of keywords on any page or create widgets for blog platforms. Not available for CN, TW, SG and HK sites.

Retrieves top-ranked contextual eBay keywords and categories for a specified web page.

CN, TW, SG, HK The URL of the web page from which eBay is to extract keywords. GetContextualKeywords Yes Web page encoding by which the URL is to be handled, such as ISO-8859-1. GetContextualKeywords Yes The ID of the category to which keywords are to be limited. Zero or more category IDs can be specified. GetContextualKeywords No Response to a GetContextualKeywords request. An array of either keyword/category pairs or categories, with ranking and score. GetContextualKeywords Always Requests a list of cross-promoted items associated with a referring item.

Requests a list of cross-promoted items associated with a referring item.

The unique ID of the referring item. The cross-promoted items will supplement this item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetCrossPromotions Yes The cross-promotion method you want to use for the returned list, either UpSell or CrossSell. GetCrossPromotions Yes The role of the person requesting to view the cross-promoted items, either seller or buyer. Default is buyer. GetCrossPromotions No Returns a list of either upsell or cross-sell items for a given item ID. The list can be filtered by the viewer's role, either buyer or seller. A list of cross-promoted items defined for a specific referring item. The list is either upsell or cross-sell items, according to the value of PromotionMethod in GetCrossPromotionsRequest. GetCrossPromotions Always Retrieves the DescriptionTemplates for a category. Request for DescriptionTemplates.

Retrieves the DescriptionTemplates for a category.

The category for which to retrieve templates. Enter any category ID, including Motors vehicle categories. This is ignored if you also send MotorVehicles. 10 GetDescriptionTemplates No If specified, only those templates modified on or after the specified date are returned. If not specified, all templates are returned. GetDescriptionTemplates No Indicates whether to retrieve templates for motor vehicle categories for eBay Motors (site 100). If true, templates are returned for motor vehicle categories. If false, templates are returned for non-motor vehicle categories such as Parts and Accessories. If included as an input field (whether true or false), this overrides any value provided for CategoryID. GetDescriptionTemplates No Returns one or more DescriptionTemplate nodes. Each DescriptionTemplate node contains the information for one Theme or one Layout. DescriptionTemplate.DescriptionTemplateType indicates whether it contains data for a Theme or a Layout. Returned after calling GetDescriptionTemplatesRequest. The information for one Theme or one Layout. There can be multiple DescriptionTemplates. GetDescriptionTemplates Always The number of Layout templates returned (that is, the number of DescriptionTemplates for which Type is "Layout"). GetDescriptionTemplates Always The ID of a returned layout that is obsolete. There can be zero or more IDs. GetDescriptionTemplates Conditionally The ID of a returned theme that is obsolete. There can be zero or more IDs. GetDescriptionTemplates Conditionally Data for one theme group. There can be multiple ThemeGroups in the response. GetDescriptionTemplates Conditionally The number of Theme templates returned (that is, the number of DescriptionTemplates for which Type is "Theme"). GetDescriptionTemplates Always Requests the record of a dispute with a given dispute ID. The dispute record contains the dispute state, dispute type, and other information. Can be used with Unpaid Item or Item Not Received disputes.

Requests the record of a dispute with a given dispute ID. Returns the entire record of a dispute, any time after the dispute was opened and up to five years after it was closed. Returns just one dispute, including any comments and resolutions and the dispute state.

The unique identifier of the dispute, returned when the dispute is created. GetDispute Yes Returned after calling GetDisputeRequest. Returns the record of a dispute, including the dispute state and other information. The dispute record, containing information about the buyer, seller, dispute state, dispute status, comments added to the dispute, or resolutions. GetDispute Always Retrieves the accumulation of feedback left for the specified user by other users. Returns summary feedback data and (in a detail level value of ReturnAll is specified) individual feedbacks.

Retrieves the accumulation of feedback left for the specified user by other users.

dl Controls the pagination of the result set. Child elements specify the maximum number of individual feedbacks to return per call and which page of data to return. Only applicable if a detail level value of ReturnAll is specified to return feedback details. feedback summary data is not paginated (but is still returned when pagination is used). GetFeedback No Specifies the user whose feedback data is to be returned. If not specified, then the feedback returned is that for the requesting user. GetFeedback No An ID that uniquely identifies a feedback to be retrieved. Used by the Feedback notification only. GetFeedback No The GetFeedback response contains the specified user's total feedback score, feedback summary data, and (if the applicable detail level is specified) an array of individual feedbacks. (out) Contains the individual feedbacks for the user, one FeedbackDetailType object for each feedback. Only populated with data when a detail level of ReturnAll is specified in the request. Not returned if you specify FeedbackID in the request. GetFeedback Conditionally ReturnAll (out) Indicates the number of FeedbackDetailType objects returned in the FeedbackDetailArray property. Only applicable if feedback details are returned. GetFeedback Conditionally ReturnAll (out) Summary feedback data for the user. Contains counts of positive, neutral, and negative feedback for predefined time periods. Only applicable if feedback details are returned. GetFeedback Conditionally none, ReturnAll (out) Indicates the total feedback score for the user. GetFeedback Always none, ReturnAll Retrieves either the current set of finance offers or a specific finance offer. Only supported on US and Canada sites. Payment method must be PayPal.

Retrieves either the current set of finance offers or a specific finance offer. Only supported on US and Canada sites. Payment method must be PayPal.

ID for promotional financing offer with which the seller is listing an item. If this is specified, the function returns only the finance offer associated with this ID number. If FinanceOfferID and LastModifiedDate are both used as input, LastModifiedDate is ignored. GetFinanceOffers No Date from which to search for finance offers. If this is specified but FinanceOfferID is not, this call will return those finance offers that have been changed since this date. GetFinanceOffers No Contains the number of finance offers and the current set of finance offers. The number of finance offers available on the site and specified in the call request. If no finance offers exist that meet the request criteria, a count of 0 is returned. GetFinanceOffers Always none, ReturnAll Set of currently available finance offers or a set that contains a specific finance offer (if a particular finance offer ID was specified in the call input). Only returned if finance offers meeting the request criteria exist. GetFinanceOffers Conditionally ReturnAll Retrieves a list of high bidders for the Dutch auction specified in the ItemID property of the request.

Retrieves a list of high bidders for the Dutch auction specified in the ItemId property of the request. A seller can use this list to determine which buyers are winning bidders and how many items each is able to purchase.

Unique item ID that identifies the Dutch auction listing for which to retrieve a list of the high bidders. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetHighBidders Yes Returns a list of high bidders for the Dutch auction specified in the ItemId property of the request. Contains a list of zero, one, or multiple OfferType objects. Each OfferType object represents the data for one high bidder. See the schema documentation for OfferType for details on its properties and their meanings. GetHighBidders Always Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., winning bidder) and other information. This processing can take several minutes. If you retrieve a sold item, use this listing status information to determine whether eBay has finished processing the listing so that you can be sure the winning bidder and other details are correct and complete. GetHighBidders Always Requests data for a specific item identified by item ID. Use no DetailLevel to return all item fields without Item.Description. Use a DetailLevel of ReturnAll to return all item fields. See GetItem in the eBay Web Services Guide for more information.

Requests data for a specific item identified by item ID. Data returned includes title, description, minimum bid price, seller information, high bidder information (if there currently is a high bidder), and shipping specifications (if the seller elected to have the buyer pay for shipping).

Specifies the item ID that uniquely identifies the item listing for which to retrieve the data. ItemID is a required input. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetItem Yes Indicates if the caller wants to include watch count for that item in the response. GetItem No Indicates if the caller wants to include cross promotions for that item in the response. Default is set to true for backward compatibility. GetItem No Contains the item data returned by the call. The data for the specified item listing is returned in an ItemType object. ItemType object that contains the data for the specified item. GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Examines potential item data that a seller has specified and returns recommended changes or opportunities for improvement. The types of recommendations returned for a given item can be configured by choosing one or more recommendation engines in the request. This call supports batch requests. That is, you can retrieve recommendations for multiple items at once.

Examines potential item data that a seller has specified and returns recommended changes or opportunities for improvement.

Specifies the data for a single item and configures the recommendation engines to use when processing the item. To retrieve recommendations for multiple items, pass a separate GetRecommendationsRequestContainer for each item. In this case, pass a user-defined correlation ID for each item to identify the matching response. GetItemRecommendations Yes GetItemRecommendations returns recommended changes or opportunities for improvement related to listing data that was passed in the request. This call supports batch requests. That is, it can retrieve recommendations for multiple items at once. Specifies recommended changes or opportunities for improving the data of a single item. If multiple items were processed, a separate GetRecommendationsResponseContainer is returned for each item. Each container includes a user-defined correlation ID to help you match items in the request to recommendations in the response. GetItemRecommendations Always Contains the input necessary to determine shipping information for an item.

Returns shipping cost estimates for an item. This is analogous to the Shipping Calculator seen in both the buyer and seller web pages. It is another way for a buyer or seller to obtain shipping cost information for an existing item (for which the caller is either the buyer or seller) at any point in the life of of the listing, before or after a buyer has committed to purchasing the item(s). This enables the user to determine the costs associated with a particular shipping service shipping to a specified postal code. (Note, however, that shipping insurance cost can only be determined once the final item price is known.)

Getting Shipping Cost Information http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts The item ID that uniquely identifies the item listing for which to retrieve the data. Required input. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetItemShipping Yes Number of items sold to a single buyer and to be shipped together. GetItemShipping No Destination country postal code (or zipcode, for US). Ignored if no country code is provided. Optional tag for some countries. More likely to be required for large countries. GetItemShipping Conditionally Destination country code. If DestinationCountryCode is US, postal code is required and represents US zip code. US GetItemShipping Conditionally Contains the data returned by the call. The shipping details for the specified item are returned in a ShippingDetails object. Shipping-related details for the specified item. Any error about shipping services (returned by a vendor of eBay's who calculates shipping costs) is returned in ShippingRateErrorMessage. Errors from a shipping service are likely to be related to issues with shipping specifications, such as package size and the selected shipping method not supported by a particular shipping service. GetItemShipping Always Returns the transactions associated with the sale of one or more items. A transaction contains the information about the sale of one or more items by one buyer from a single listing. GetItemTransactions retrieves a report containing information you can use to process one listing's transactions. (Often, it is more efficient to use GetSellerTransactions instead. See the reference guide for more information.) As some listings can return large numbers of transactions, use the supplied time filters to retrieve only those transactions whose status has been modified between two dates. Optionally, also configure the request to retrieve one page of data at a time (where each page contains a more manageable number of transactions). All the listing's transactions that were modified within the specified date range can be retrieved, or a single transaction can be retrieved. However, retrieving transactions one at a time is inefficent and requires more API calls. In general, only fields that are necessary for processing transactions are returned. For example, reserve price information would not be returned because the data is not relevant once the agreement to purchase the item has occurred. Also, fields that are not logically applicable are not returned. For example, TransactionArray.Transaction.Buyer.SellerInfo is not returned because the buyer is not acting in the role of a seller for the transaction. As the ItemType object is returned at the root level of the response, and as all transactions returned from this call are from the same item, each individual TransactionType object does not return an ItemType object. Notes: - In the TransactionArray.Transaction.ShippingDetails object, only one of FlatShippingRate or CalculatedRate will be returned, depending on which one the seller set. - In the Item.Buyer and Item.Seller objects, email and address data is only returned under certain conditions. - The Item.ListingDetails.RelistedItemID object is only returned if the item was re-listed.

Retrieves data for transactions created by the sale of items from a single, specified listing. Input is the item ID for the item that spawned the transactions. GetItemTransactions returns zero, one, or multiple transactions (depending on the sale of items from the listing and the listing type). The result set can include only the transactions created between two specified dates.

dl Email and Address Privacy Policy http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EmailPrivacyPolicy the conditions under which buyer and seller email and address are returned Unique item ID for the item for which to retrieve transactions. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetItemTransactions Yes Describes the earliest (oldest) date to use in a date range filter based on the time the transaction status was modified. Filters out transactions whose status was last modified before this date. The date range between ModTimeFrom to ModTimeTo cannot be greater than 30 days. GetItemTransactions Yes Describes the latest (most recent) date to use in a date range filter based on the time a transaction's status was modified. Filters out transactions whose status was last modified after this date. The date range between ModTimeFrom to ModTimeTo cannot be greater than 30 days. It is considered a best practice to always pass the current date-time, to ensure that no data is missed. GetItemTransactions Yes Identifies one transaction for a listing. For Chinese auctions listings (single-item listings for which there can be only one transaction), TransactionID is always 0, and for multi-quantity listings (for which there can be multiple transactions), TransactionID has a non-0 value. To determine the valid transaction IDs for a listing, you typically need to have previously executed GetItemTransactionsCall or GetSellerTransactionsCall and stored all the listing's transactions. 10 GetItemTransactions No Child elements control pagination of the output. Use its EntriesPerPage property to control the number of transactions to return per call and its PageNumber property to specify the page of data to return. GetItemTransactions No Indicates whether to include final value fees in the response. For most listing types, the fee is returned in Transaction.FinalValueFee. For Dutch auctions that end with bids (not Buy It Now purchases), the fee is returned in Item.SellingStatus.FinalValueFee. The Final Value Fee for FixedPriceItem, StoresFixedPrice, and Buy It Now Dutch listing types is returned on a transaction by transaction basis. For all other listing types, including Chinese and Dutch (no Buy It Now purchases), the Final Value Fee is returned when the listing status is Completed. GetItemTransactions No For future use. GetItemTransactions No Returns an array of transaction data for the item specified in the request. The results can be used to create a report of data that is commonly necessary for end-of-auction processing. Zero, one, or many Transaction objects can be returned in the array. The set of transactions returned is limited to those that were modified between the times specified in the request's ModTimeFrom and ModTime filters. Also returns the item object that spawned the transactions. If pagination filters were specified in the request, returns meta-data describing the effects of those filters on the current response and the estimated effects if the same filters are used in subsequent calls. Contains the total number of pages (TotalNumberOfPages) and the total number of entries (TotalNumberOfEntries) that could be returned given repeated calls that use the same selection criteria as the call that returned this response. GetItemTransactions Always none, ReturnAll, ItemReturnDescription Indicates whether there are additional transactions to retrieve. That is, indicates whether more pages of data are available to be returned, given the filters that were specified in the request. Returns false for the last page of data. GetItemTransactions Always none, ReturnAll, ItemReturnDescription Number of transactions returned per page (per call). May be a higher value than ReturnedTransactionCountActual if the page returned is the last page and more than one page of data exists. GetItemTransactions Always none, ReturnAll, ItemReturnDescription Page number for the page of transactions the response returned. GetItemTransactions Always none, ReturnAll, ItemReturnDescription Number of transactions retrieved in the current page of results just returned. May be a lower value than TransactionsPerPage if the page returned is the last page and more than one page of data exists. GetItemTransactions Always none, ReturnAll, ItemReturnDescription Item object that spawned the transaction. It is a purchase from this item's listing that the transaction represents. GetItemTransactions Always none, ReturnAll, ItemReturnDescription List of Transaction objects representing the transactions resulting from the listing. Each Transaction object contains the data for one purchase (of one or more items in the same listing). The Transaction.Item field is not returned because the Item object is returned at the root level of the response. See the reference guide for more information about the fields that are returned. GetItemTransactions Conditionally none, ReturnAll, ItemReturnDescription Indicates whether the item's seller has the preference enabled that shows that the seller prefers PayPal as the method of payment for an item. This preference is indicated on an item's View Item page and is intended to influence a buyer to use PayPal to pay for the item. GetItemTransactions Always none, ReturnAll, ItemReturnDescription Requests items awaiting feedback from the user's My eBay account.

Requests items awaiting feedback from the user's My eBay account.

Specifies how the returned feedback items should be sorted. Valid values are Title, TitleDescending, UserID, UserIDDescending, EndTime, EndTimeDescending, FeedbackReceived, FeedbackReceivedDescending, FeedbackLeft, and FeedbackLeftDescending. GetItemsAwaitingFeedback No Specifies the number of entries per page and the page number to return in the result set. GetItemsAwaitingFeedback No (out) Returns items from a user's My eBay account that do not yet have feedback. (out) Contains the items awaiting feedback. Returned only if there are items that do not yet have feedback. GetItemsAwaitingFeedback Always Includes the list of bidders for the requested catalog.

Gets a list of users who have signed up to participate in their auctions, including the bid approval status of each user.

Number that identifies the seller's eBay Live Auctions catalog for which they want to retrieve bidder requests. GetLiveAuctionBidders Yes The seller can ask to retrieve a subset of users in the bidder approval list who are either "approved","denied", or "pending" or a combination of these. If this field is not specified in the request, all records are returned. GetLiveAuctionBidders No Child elements control pagination of the output. Use its EntriesPerPage property to control the number of bidders to return per call and its PageNumber property to specify the page of data to return. GetLiveAuctionBidders No Includes the list of bidders for the requested catalog. Contains the bidder details that match the bidder query passed in the request. Returned when bidder search results are found. GetLiveAuctionBidders Conditionally Total number of bidders in Pending state. GetLiveAuctionBidders Always Total number of bidders in Approved state. GetLiveAuctionBidders Always Total number of bidders in Denied state. GetLiveAuctionBidders Always The page number for the page of data returned. GetLiveAuctionBidders Conditionally Shows the pagination of data returned by requests. Only returned if Pagination was specified in the request. GetLiveAuctionBidders Conditionally Retrieves all the eBay Live Auctions catalogs and upcoming sale schedules that the user has created. Only returns data if the requestor is an authorized eBay Live Auctions seller with at least one catalog. If the seller's auction house has no upcoming sales, no schedules are returned.

Retrieves all the eBay Live Auctions catalogs and upcoming sale schedules that the user has created.

Returns all the upcoming eBay Live Auctions catalogs and sale schedules that the user has created. Each eBay Live Auctions catalog describes one live auction catalog created by the user, along with one or more sale schedules. Use this information to determine an appropriate combination of catalog and schedule IDs in which to list lot items with AddLiveAuctionItem. Only returns details about catalogs that contain pending sales. That is, if a catalog has no sales or all its sales have ended, the catalog details are not returned. GetLiveAuctionCatalogDetails Conditionally Retrieves a list of the messages buyers have posted about your active item listings.

Retrieves messages posted to the Ask Seller A Question messaging system.

The ID of the message. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetMemberMessages Yes The type of message. GetMemberMessages Yes The status of the message. GetMemberMessages Conditionally Specifies if the message should be displayed on the website with the item listing. GetMemberMessages No Used as beginning of date range filter. GetMemberMessages Yes Used as end of date range filter. GetMemberMessages Conditionally Standard pagination argument used to reduce response. GetMemberMessages Yes An ID that uniquely identifies the message for a given user to be retrieved. Used for the AskSellerQuestion notification only. GetMemberMessages No The returned member messages. Returned if messages that meet the request criteria exist. GetMemberMessages Conditionally Shows the pagination of data returned by requests. GetMemberMessages Always Specifies whether the response has more items. GetMemberMessages Always Used to retrieve information about the messages and alerts sent to a given user. Depending on the detail level, this information can include message and alert counts, resolution and flagged status, message and/or alert headers, and message and/or alert body text. Note that this call requires a DetailLevel in the request. Omitting the Detail Level returns an error.

Retrieves information about the messages and alerts sent to a given user.

Contains a list of up to 10 AlertID values. When AlertID values are used as input, you must generally specify either AlertID values, or MessageID values, or both. GetMyMessages Conditionally Contains a list of up to 10 MessageID values. When MessageID values are used as input, you must generally specify either AlertID values, or MessageID values, or both. GetMyMessages Conditionally An ID that uniquely identifies the My Messages folder from which to retrieve alerts or messages. GetMyMessages No Conains information about the messages and alerts sent to a given user. Depending on the detail level, this information can include message and alert counts, resolution and flagged status, message and/or alert headers, and message and/or alert body text. Summary data for a given user's alerts and messages. This includes the numbers of new alerts and messages, unresolved alerts, flagged messages, and total alerts and messages. The amount and type of data returned is the same whether or not the request included specific AlertID or MessageID values. Always/Conditionally returned logic assumes a detail level of ReturnMessages. GetMyMessages Conditionally ReturnSummary Contains the alert information for each alert specified in AlertIDs. The amount and type of information returned varies based on the requested detail level. Contains one MyMessagesAlertType object per alert. Returned as an empty node if user has no alerts. GetMyMessages Conditionally ReturnHeaders, ReturnMessages Contains the message information for each message specified in MessageIDs. The amount and type of information returned varies based on the requested detail level. Contains one MyMessagesMessageType object per message. Returned as an empty node if user has no messages. GetMyMessages Conditionally ReturnHeaders, ReturnMessages GetMyeBay will be DEPRECATED SOON and should not be used. Instead, please use GetMyeBayBuying and related calls to retrieve a users's My eBay data. Retrieves data for the requesting user's My eBay page. This data includes a list of items the user is watching and a list of items the user has bid on. You must specify at least one field in the request to receive data in the response. In addition, you must include at least one sort field - BiddingSort, LostSort, WatchSort, or WonSort.

To be deprecated. Use GetMyeBayBuying and related calls.

Specifies how the items in the active list (the items the user has bid on) are sorted in the result set. The items may be sorted by item ID, price, title, bid count, and listing end time. See the code list ItemSortTypeCodeType for valid input values. GetMyeBay Conditionally Specifies how the items in the lost list (items the user has bid on but has not won) are sorted in the result set. The items may be sorted by item ID, price, title, bid count, and listing end time. See the code list ItemSortTypeCodeType for valid input values. GetMyeBay Conditionally Specifies maximum number of items to display in each of the lists. Recommended value is 5. If not specified, all possible items for each list are returned. One maximum is specified and applies to all of the lists in the result set. GetMyeBay No Specifies the number of days prior to the current time (based on item end time) to retrieve items. Applies only to the items won and items lost lists. Default value is 2. Maximum value is 30. GetMyeBay No Specifies how the items in the watch list (the items the user is watching) are sorted in the result set. The valid values of ItemSortTypeCodeType are ItemID, ItemIDDescending, Price, PriceDescending, BidCount, BidCountDescending, SellerUserID, SellerUserIDDescending, TimeLeft, and TimeLeftDescending. GetMyeBay Conditionally Specifies how the items in the won list (the items the user has won) are sorted in the result set. The items may be sorted by item ID, price, title, bid count, and listing end time. See the code list ItemSortTypeCodeType for valid input values. GetMyeBay Conditionally A user's favorite eBay searches. Corresponds to the Searches selection under All Favorites on the My eBay page. A user's favorite eBay sellers. Corresponds to the Sellers selection under All Favorites on the My eBay page. Second Chance Offers for items. Corresponds to the Second Chance Offers listed on the My eBay page. GetMyeBay will be DEPRECATED SOON and should not be used. Instead, please use GetMyeBayBuying and related calls to retrieve a users's My eBay data. Contains the lists of items from the requesting user's My eBay page. This includes a list of the items the user has bid on and a list of the items the user is watching. The number of items returned in any list can be controlled using the MaxItemsPerList property of the request object. Contains the list of items the requesting user has bid on. BiddingItemArray is an array of ItemType objects, each of which represents one item. GetMyeBay Conditionally Contains the list of items the requesting user has bid on but not has won. LostItemArray is an array of ItemType objects, each of which represents one item. GetMyeBay Conditionally Contains the list of items the requesting user is watching. WatchItemArray is an array of ItemType objects, each of which represents one item. GetMyeBay Conditionally Contains the list of items the requesting user has won. WonItemArray is an array of ItemType objects, each of which represents one item. GetMyeBay Conditionally Contains a list of the user's My eBay Favorite Searches. GetMyeBay Conditionally Contains a list of the user's My eBay Favorite Sellers. GetMyeBay Conditionally Contains a list of the user's My eBay Second Chance Offers. GetMyeBay Conditionally Returns items from the All Buying section of the user's My eBay account, including items the user is watching, bidding on, has won, has not won, or has made best offers on. Use DetailLevel of ReturnSummary to return only the BuyingSummary and the specific containers requested. The DetailLevel ReturnAll returns the BuyingSummary and all containers.

Returns items from the All Buying section of the user's My eBay account, including items the user is watching, bidding on, has won, has not won, or has made best offers on.

Specifies how to return the list of watched items in the user's My eBay list. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of items bid on in the user's My eBay list. Allowed values are Sort and IncludeNotes.Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of items on which the user has placed best offers. Allowed values are Include, ListingType, Sort, DurationInDays (0-60 valid), IncludeNotes, and Pagination. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of items bid on and won in the user's My eBay list. Allowed values are DurationInDays (valid values 0-60), Sort, IncludeNotes, and Pagination. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of items bid on and lost in the user's My eBay list. Allowed values are DurationInDays (valid values 0-60), Sort, IncludeNotes, and Pagination. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of favorite searches in the user's My eBay list. All values are allowed. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of favorite sellers in the user's My eBay list. All values are allowed. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of second chance offers in the user's My eBay list. All values are allowed. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Returns items from All Buying or All Favorites in the user's GetMyeBay account. Returns items from All Buying or All Favorites in the user's My eBay account. Contains a summary of the items the user has bid on. Returned at all detail levels. GetMyeBayBuying Always none, ReturnSummary, ReturnAll Contains the items the user is watching. Only returned if items exist that meet the request criteria. GetMyeBayBuying Conditionally none, ReturnSummary, ReturnAll Contains all the items the user has bid on. Only returned if items exist that meet the request criteria. GetMyeBayBuying Conditionally none, ReturnSummary, ReturnAll Contains the items the user has placed best offers on. Only returned if items exist that meet the request criteria. GetMyeBayBuying Conditionally none, ReturnSummary, ReturnAll Contains the items the user has bid on and won. Only returned if items exist that meet the request criteria. GetMyeBayBuying Conditionally none, ReturnSummary, ReturnAll Contains the items the user has bid on and lost. Only returned if items exist that meet the request criteria. GetMyeBayBuying Conditionally none, ReturnSummary, ReturnAll Contains a list of the user's favorite searches. Only returned if items exist that meet the request criteria. GetMyeBayBuying Conditionally none, ReturnSummary, ReturnAll Contains a list of the user's favorite sellers. Only returned if items exist that meet the request criteria. GetMyeBayBuying Conditionally none, ReturnSummary, ReturnAll Contains the list of second chance offers the user has received. Only returned if items exist that meet the request criteria. GetMyeBayBuying Conditionally none, ReturnSummary, ReturnAll Requests reminder type totals from the user's MyeBay account.

Requests totals of various reminder types from the user's MyeBay account.

Specifies the type of buying reminders for which you want information. GetMyeBayReminders No Specifies the type of selling reminders for which you want information. GetMyeBayReminders No Returns totals of various reminder types from the user's My eBay account. Returns totals of various reminder types from the user's My eBay account. (out) Contains the buying reminders in the user's My eBay account that match the request criteria. GetMyeBayReminders Conditionally (out) Contains the selling reminders in the user's My eBay account that match the request criteria. GetMyeBayReminders Conditionally Returns a summary and details of items a user is selling from the user's My eBay account. Use no DetailLevel to return SellingSummary and any containers specified in the request. The DetailLevel ReturnAll returns SellingSummary and all containers.

Returns a summary and details of items a user is selling from the user's My eBay account.

Contains the list of items the user has scheduled to sell but whose listings have not yet opened. Valid subelements are Sort, IncludeNotes, and Pagination. GetMyeBaySelling No Contains the list of items the user is actively selling whose listings are active. Valid subelements are Sort, IncludeNotes, Pagination, and ListingType (with valid values Auction, FixedPriceItem, StoresFixedPrice, or AdType). Note that if a DetailLevel of ReturnAll is specified in the request, this element is ignored as a way to filter the response, and ALL containers are returned. GetMyeBaySelling No Contains the list of items the user has sold. Valid subelements are DurationInDays (with valid values 0-60), IncludeNotes, and Pagination. Note that if a DetailLevel of ReturnAll is specified in the request, this element is ignored as a way to filter the response, and ALL containers are returned. GetMyeBaySelling No Contains the list of items the user has listed but whose listings have ended without being sold. Valid subelements are DurationInDays (with valid values 0-60), Sort, IncludeNotes, and Pagination. Note that if a DetailLevel of ReturnAll is specified in the request, this element is ignored as a way to filter the response, and ALL containers are returned. GetMyeBaySelling No Returns summary and detail information about items the user is selling, items scheduled to sell, currently listed, sold, and closed but not sold. Returns summary and detail information about items the user is selling, items scheduled to sell, currently listed, sold, and closed but not sold. Contains summary information about the items the user is selling. GetMyeBaySelling Always Contains the items the user has scheduled for sale, but whose listings have not yet started. GetMyeBaySelling Conditionally Contains the items the user is selling that have active listings. GetMyeBaySelling Conditionally Contains the items the user has sold. GetMyeBaySelling Conditionally Contains the items whose listings have ended but that have not sold. GetMyeBaySelling Conditionally Retrieves the requesting application's notification preferences. GetNotificationPreferences retrieves preferences that you have deliberately set. For example, if you enable the EndOfAuction event and then later disable it, the response shows the EndOfAuction event preference as Disabled. But if you have never set a preference for the EndOfAuction event, no EndOfAuction preference is returned at all.

Retrieves the requesting application's notification preferences.

Specifies what type of Preference to retrieve. GetNotificationPreferences Yes Contains the requesting application's notification preferences. GetNotificationPreferences retrieves preferences that you have deliberately set. For example, if you enable the EndOfAuction event and then later disable it, the response shows the EndOfAuction event preference as Disabled. But if you have never set a preference for the EndOfAuction event, no EndOfAuction preference is returned at all. (out) Specifies application-based event preferences that have been enabled. GetNotificationPreferences Conditionally (out) Specifies user-based event preferences that have been enabled or disabled. GetNotificationPreferences Conditionally (out) return user data for notification settings such as set mobile phone number etc. GetNotificationPreferences Conditionally (out) Characteristics or details of an event such as type, name and value. GetNotificationPreferences Conditionally Retrieves information about notifications sent to a given application. The application (AppID) is determined the requester credentials. Use this notification information to troubleshoot issues with platform notifications. Developers can make up to 50 GetNotificationsUsage calls per hour for a given application.

Retrieves information about platform notifications sent to a given application.

Specifies the start date and time for which notification information will be retrieved. StartTime is optional. If no StartTime is specified, the default value of 24 hours prior to the call time is used. If no StartTime is specified or if an invalid StartTime is specified, date range errors are returned in the response. For a StartTime to be valid, it must be no more than 72 hours before the time of the call, it cannot be more recent than the EndTime, and it cannot be later than the time of the call. If an invalid StartTime is specified, the default value is used. GetNotificationsUsage Conditionally Specifies the end date and time for which notification information will be retrieved. EndTime is optional. If no EndTime is specified, the current time (the time the call is made) is used. If no EndTime is specified or if an invalid EndTime is specified, date range errors are returned in the response. For an EndTime to be valid, it must be no more than 72 hours before the time the of the call, it cannot be before the StartTime, and it cannot be later than the time of the call. If an invalid EndTime is specified, the current time is used. GetNotificationsUsage Conditionally Specifies an item ID for which detailed notification information will be retrieved. ItemID is optional. If no ItemID is specified, the response will not include any individual notification details. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetNotificationsUsage Conditionally Returns an array of notifications sent to a given application identified by the appID (comes in the credentials). The result can be used by third-party developers troubleshoot issues with notifications. Zero, one or many notifications can be returned in the array. The set of notifications returned is limited to those that were sent between the StartTime and EndTime specified in the request. If StartTime or EndTime filters were not found in the request, then the response will contain the data for only one day (Now-1day). By default, maximum duration is limited to 3 days (Now-3days). These min (1day) and max(3days) applies to Notifications,MarkDownMarkUpHistory and NotificationStatistics. Notifications are sent only if the ItemID is included in the request. If there is no ItemID, then only Statistics and MarkDownMarkUpHistory information is included. Returns the start date and time for the notification information that is returned by this call. The oldest date allowed for this field is Now-3days. Default is Now-1day. GetNotificationsUsage Always Returns the end date and time for the notification information that is returned by this call. The default is Now. GetNotificationsUsage Always List of notification objects representing the notifications sent to an application for the given time period. It will only be returned if ItemID was specified in the input request. GetNotificationsUsage Conditionally List of objects representing MarkUp or MarkDown history for a given appID and for given StartTime and EndTime. This node will always be returned. GetNotificationsUsage Always Summary information about number of notifications that were successfully delivered, queued, failed, connection attempts made, connection timeouts, http errors for the given appID and given time period. By default, statistics for only one day (Now-1day) is included. Maximum time duration allowed is 3 days (Now-3days). GetNotificationsUsage Always Retrieves information about one or more orders or one or more transactions (or both), thus displacing the need to call GetOrders and GetItemTransactions separately.

Retrieves information about one or more orders or one or more transactions (or both). You can use GetOrderTransactions instead of making separate GetOrders and GetItemTransactions calls.

dl An array of ItemTransactionIDs. GetOrderTransactions Conditionally An array of OrderIDs. GetOrderTransactions Conditionally Response to GetOrderTransactions request. An array of Orders. GetOrderTransactions none Always Retrieves all of the orders for which the user is a participant (as either buyer or seller) that meet the criteria specified in the request object. There are two mutually exclusive sets of filtering input arguments that can be used to query for orders. The first set is based on specific order IDs (one or more order IDs are passed in the call). The second set is a combination of date range, order role, and order status. If one set of filtering arguments is used, the arguments for the other set should not be specified in the same call. If a given call to GetOrders includes both criteria sets, the query based on order IDs is used, and the criteria for date range/order status/order role is ignored. This call can also be used to retrieve unshipped Half.com orders (i.e., orders that the seller has received but has not yet processed).

Retrieves all of the orders for which the user is a participant (as either buyer or seller) that meet the criteria specified in the request object.

A set of orders to retrieve. Not applicable to Half.com. GetOrders Conditionally The starting date of the date range for the orders to retrieve. Also applicable to Half.com. GetOrders Conditionally The ending date of the date range for the orders to retrieve. Also applicable to Half.com. GetOrders Conditionally Filters the returned orders to only those where the user for whom the call is being made is a participant in the order in the specified role. Not applicable to Half.com. GetOrders Conditionally Filters the returned orders by order status. Not applicable to Half.com. If you set ListingType to Half and you include OrderStatus in the request, GetOrders may return incomplete information or have indeterminate results. Therefore, please do not specify OrderStatus when you retrieve Half.com orders. GetOrders Conditionally Cannot be used as a filter on eBay.com. If not provided or if any value other than Half is specified, the call retrieves eBay orders. If Half is specified, the call retrieves Half.com orders. (You cannot retrieve both eBay and Half.com orders in the same response.) GetOrders Conditionally Not applicable to eBay.com. Applicable to Half.com. If many orders are available, you may need to call GetOrders multiple times to retrieve all the data. Each result set is returned as a page of entries. Use this Pagination information to indicate the maximum number of entries to retrieve per page (i.e., per call), the page number to retrieve, and other data. GetOrders No Returns the set of orders that match the order IDs or filter criteria specified. Applies only to Half.com. Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries. GetOrders Always Applies only to Half.com. If true, there are more orders yet to be retrieved. Additional GetOrders calls with higher page numbers or more entries per page must be made to retrieve these orders. If false, no more orders are available or no orders match the request (based on the input filters). GetOrders Always The set of orders that match the order IDs or filter criteria specified. Also applicable to Half.com (only returns orders that have not been marked as shipped). GetOrders Always Applies only to Half.com. Indicates the number of orders that can be returned per page of data (i.e., per call). This is the same as the value specified in the Pagination.EntriesPerPage input (or the default value, if EntriesPerPage was not specified). This is not necessarily the actual number of orders returned per page (see ReturnedOrderCountActual). GetOrders Always Applies only to Half.com. Indicates which page of data holds the current result set. Will be the same as the value specified in the Pagination.PageNumber input. If orders are returned, the first page is 1. GetOrders Always Applies only to Half.com. Indicates the total number of orders returned. GetOrders Always Requests information about folders or pictures in a Picture Manager account or the account settings.

Requests information about folders or pictures in a Picture Manager account or the account settings.

The ID of a folder in the user's Picture Manager album for which you want information. If you specify both FolderID and PictureURL, the picture must exist in the folder. GetPictureManagerDetails No The URL of a picture in the user's Picture Manager album. If you specify both FolderID and PictureURL, the picture must exist in the folder. GetPictureManagerDetails No The type of information you want returned, about pictures and folders, the account subscription, or both. Use this element rather than the generic DetailLevel element defined in AbstractRequestType. You can use the following values: ReturnAll, ReturnSubscription, or ReturnPicture. GetPictureManagerDetails No Responds with information about content in a Picture Manager album or the account settings. Contains details of the account settings, folders or pictures in the user's album, or both. GetPictureManagerDetails none, ReturnSubscription, ReturnPicture, ReturnAll Always Requests a list of Picture Manager options and allowed values, such as subscription type and picture display.

Requests a list of Picture Manager options and allowed values, such as subscription type and picture display.

Returns a list of Picture Manager options and allowed values. A type of Picture Manager subscription, with a subscription level, fee, and allowed storage size. GetPictureManagerOptions Always A global definition for displaying pictures, with a maximum size. GetPictureManagerOptions Always Retrieves the words more frequently used by eBay users when searching for listings. These keywords are generated weekly by eBay. Thus, calls retrieve static data. GetPopularKeywords is not available for the following SiteIDs 71 ,201, 207, 211, 212, 216, 218.

Retrieves the words more frequently used by eBay users when searching for listings.

A category ID for which you want keywords returned. When IncludeChildCategories is true, one and only one CategoryID is allowed. Otherwise, up to 100 CategoryIds are allowed. To retrieve the keywords for root category, set one of the CategoryIDs to -1 or submit no CategoryIDs at all. 10 GetPopularKeywords No If true, only one CategoryID can be specified, and keywords are returned for that category and its subcategories. If false, keywords are returned only for the categories identified by CategoryID. Default is false. GetPopularKeywords No The maximum number of keywords to be retrieved per category for this call. GetPopularKeywords No 1 1000 20 Details about how many categories to return per page and which page to view. GetPopularKeywords No Contains the keyword data for the requested categories. A category's data are contained in a CategoryArrayType object if there is no error (one or more CategoryType objects). Each CategoryType contains its ID, parent ID and keyword list. Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries. GetPopularKeywords Conditionally Organization of keywords by category. For each category, its ID and its parent's ID and keywords are listed. GetPopularKeywords Always Indicates whether there are more categories beyond the subset returned in the last call to GetPopularKeywords. Returned only when IncludeChildCategories is true. GetPopularKeywords Conditionally GetProductFamilyMembers is intended to be used combination with GetProductSearchResults. If a search result returned from GetProductSearchResults does not return all product versions in a family, and if the user wants to see more versions (editions) of the product, you can use GetProductFamilyMembers to retrieve all versions of the product. That is, if GetProductSearchResultsonly returns the product family header (ParentProduct), use this call to zoom in on a particular family of product versions. (This situation usually occurs when you call GetProductSearchResults and more more matches are found than the MaxChildrenPerFamily value you specified.) The structure of tGetProductFamilyMembers is similar to that of GetProductSearchResults. Instead of passing in a query, you pass in a product ID. This product ID is used to find all the members of the product family that the specified product is a member of. The results are compatible with the results from GetProductSearchResults, so similar application logic can be used to handle both requests and responses. This call supports batch requests. This means you can retrieve products in multiple families by using a single request. To perform a batch request, pass an array of ProductSearch objects in the call. For each ProductSearch object, GetProductFamilyMembers returns a list of all the products in the specified product family. Each product is represented as a list of attributes (Item Specifics) plus other identifying information, such as a product ID and a stock photo. Once the user selects a product from the results, pass its ID in a GetProductSellingPages request to retrieve more detailed information about the product, including a set of optional Item Specifics that the seller can use in addition to the pre-filled Item Specifics (see GetProductSellingPages). To use this data in a listing, pass the product ID and the optional Item Specifics in the seller's listing request (AddItem).

If a search result returned from GetProductSearchResults does not return all product versions in a family, and if the user wants to see more versions (editions) of the product, you can use GetProductFamilyMembers to retrieve all versions of the product.

Specifies the ID of a product in the family to be retrieved, along with pagination and sorting instructions. ProductSearch is a required input. GetProductFamilyMembers Yes GetProductFamilyMembers performs a product search and returns results comprising all the children in the product family identified by a product ID that was specified in the request. Use this call when more matches are found than the max amount specified per family in a call to GetProductSearchResults. This call supports batch requests. This means you can retrieve products in multiple families by using a single request. The results are compatible with the results from GetProductSearchResults, so similar application logic can be used to handle both requests and responses. Container for one or more DataElement fields containing supplemental helpful data. A DataElement field is an HTML snippet that specifies hints for the user, help links, help graphics, and other supplemental information that varies per characteristics set. Usage of this information is optional and may require developers to inspect the information to determine how it can be applied in an application. GetProductFamilyMembers Always Contains the attributes and summary product details for all products that match the product ID (or IDs) passed in the request. GetProductFamilyMembers Always Retrieves data that you use to construct valid "product finder" queries (queries against multiple attributes) against catalog products or listed items. The attributes describe search criteria (e.g., Manufacturer), as appropriate for the category. Use the results in combination with GetProductFinderXSL to render the Product Finder in a graphical user interface. GetProductFinder does not conduct the actual product or listing search. It only returns data about what you can search on. Use the data as input to GetProductSearchResults to conduct the actual search for product information or as input to GetSearchResults to conduct the search for listed items. To retrieve single-attribute search criteria (querying against a single attribute, like UPC), use GetProductSearchPage instead (only applicable for catalog searches). See the Developer's Guide for an overview of Pre-filled Item Information and details about searching for catalog products and for information about searching for listed items.

Retrieves data that you use to construct valid "product finder" queries (queries against multiple attributes) against catalog products or listed items.

A version of the product finder attribute definitions for the site. Typically, an application passes the version value that was returned the last time the application executed this call. Filter that causes the call to return only the Product Finders for which the attribute meta-data has changed since the specified version. The latest version value is not necessarily greater than the previous value that was returned. Therefore, when comparing versions, only compare whether the value has changed. GetProductFinder No A number that uniequely identifies a product finder. To determine the product finder IDs for a category, call GetCategory2CS. Multiple categories can be mapped to the same product finder ID. You can pass zero or multiple IDs in the request. When IDs are specified, the call only returns product finder meta-data for the specified product finders. When no IDs are specified, the call returns all the current product finder meta-data available on the site. GetProductFinder No For a category that supports product finders, GetProductFinder returns an XML string that decribes the attributes a seller can use to form a query when searching for Pre-filled Item Information, or attributes that can be used to search for listed items. Specifically, it retrieves data that you use to construct valid "product finder" queries (queries against multiple attributes). Use the results in combination with GetProductFinderXSL to render the Product Finder in a graphical user interface. See the Developer's Guide for an overview of Pre-filled Item Information and details about searching for catalog products and for information about searching for listed items. Current version of the product search page data for the site. This value changes each time changes are made to the search page data. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. GetProductFinder Conditionally none, ReturnAll A string containing a list of search attributes that can be used in a "Product Finder" style query, along with related meta-data. The meta-data specifies possible values of each attribute, the logic for presenting attributes to a user, and rules for validating the user's selections. For backward compatibility, this data is in the same XML format that was used in the Legacy XML API so that you can apply the same Product Finder XSL stylesheet to it. That is, individual elements are not described using the new eBay XML schema format. For information about each element in the ProductFinderData string, see the product finder model documentation in the eBay Web Services guide (see links below). Because this is returned as a string, the XML markup is escaped with character entity references (e.g., &lt;eBay&gt;&lt;ProductFinders&gt;...). See the appendices in the eBay Web Services guide for general information about string data types. GetProductFinder Conditionally ReturnAll The Product Finder Meta-Data Model http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFModel Data Types http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DataTypes Retrieves the Product Finder XSL stylesheet. Apply the stylesheet to the XML returned from a call to GetProductFinder to render a form that lets a user form a multi-attribute query against eBay catalog data. See the Developer's Guide for an overview of Pre- filled Item Information and information on searching for catalog products.

Retrieves the Product Finder XSL stylesheet for use with the XML returned from GetProductFinder.

The name of the XSL file to retrieve. If not specified, the call returns the latest versions of all available XSL files. FileName is an optional input. GetProductFinderXSL No The desired version of the XSL file. Required if FileName is specified. IIf not specified, the call returns the latest versions of all available XSL files that could be returned by the call. This is not a filter for retrieving changes to the XSL files. GetProductFinderXSL No Retrieves the Product Finder XSL stylesheet. Apply the stylesheet to the XML returned from a call to GetProductFinder to render a form that lets a user form a multi-attribute query against eBay catalog data. See the Developer's Guide for an overview of Pre-filled Item Information and information on searching for catalog products. Child elements specify data related to one XSL file. See XSLFileType. Multiple XSLFile objects can be returned. GetProductFinderXSL Always none, ReturnAll Retrieves the attributes a seller can use to form a query when searching for Pre-filled Item Information to use in a listing for a category that is catalog-enabled. This call is applicable for use cases related to listing items with Pre-filled Item Information. Specifically, it retrieves data that you use to construct valid "single-attribute" queries. The attributes describe search criteria (e.g., Author) and sorting criteria (e.g., Publication Year), as appropriate for the category. GetProductSearchPage does not conduct the actual product search. It only returns data about what you can search on. Use the data as input to GetProductSearchResults to conduct the actual search for product information. To retrieve Product Finder search criteria (querying against multiple attributes), use GetProductFinder instead. See the eBay Web Services guide for an overview of Pre-filled Item Information and details about searching for catalog products.

Retrieves the attributes a seller can use to form a query when searching for Pre-filled Item Information to use in a listing for a category that is catalog-enabled.

A version of the search page definitions for the site. Typically, an application passes the version value that was returned the last time the application executed this call. Filter that causes the call to return only the search pages for which the attribute meta-data has changed since the specified version. The latest version value is not necessarily greater than the previous value that was returned. Therefore, when comparing versions, only compare whether the value has changed. GetProductSearchPage No A characteristic set ID that is associated with a catalog-enabled category that supports product search pages. You can pass an array of these IDs in the request. Each characteristic set corresponds to a level in the eBay category hierarchy at which all items share common characteristics. Multiple categories can be mapped to the same characteristic set. Each ID is used as a filter to limit the response content to fewer characteristic sets. When IDs are specified, the call only returns search page data for the corresponding characteristic sets. When no IDs are specified, the call returns all the current search page data in the system. GetProductSearchPage No For a category that is catalog-enabled, GetProductSearchPage retrieves the attributes a seller can use to form a query when searching for Pre-filled Item Information. See the Developer's Guide for an overview of Pre-filled Item Information and details about searching for catalog products. Current version of the product search page data for the site. This value changes each time changes are made to the search page data. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. GetProductSearchPage none, ReturnAll Always A list of catalog search criteria and sort keys associated with a catalog-enabled category, plus supplemental information to help the seller understand how to make selections. GetProductSearchPage ReturnAll Always Searches for Pre-filled Item Information within one or more characteristic sets. This kind of search is only applicable in the context of the Sell Your Item use case. Use the response to present the seller with a list of products found in a catalog. (For buy-side searches, use GetSearchResults.) See the Attributes and Catalogs section of the eBay Web Services guide for background information and terminology definitions, as well as information about how to use this call in the Sell Your Item flow. You can use this call to search for different products at the same time. That is, this call can perform batch searches. Given an array of ProductSearch properties that are configured with a list of search attributes or keywords (and other information), GetProductSearchResults searches an eBay catalog for products that match each query. Some queries can be configured to also specify a sort order for the results. To configure a ProductSearch object to search by attributes, you need a valid combination of search attributes. If you want to use a sort order other than the default order, you also need a valid sort attribute. We offer two calls that return product search and sort attributes. Use GetCategory2CS to determine which one of these calls you can use for a given category. At least one approach is offered for each catalog-enabled category, and some cases, both are offered. GetProductSearchPage: Use this call when you want to configure a simple query that consists of a single search attribute (with a value). This retrieves a single product or a very short list of search results to choose from. Some products are fairly easy to find based on a single attribute. For example, in Consumer Electronics categories (Digital Cameras, Cell Phones, and PDAs), you can specify a unique (or nearly unique) identifier, like a part number. In Media categories (Books, DVDs & Movies, Music, and Video Games), you can specify a descriptive name, like a title. GetProductFinder: Use this call when you want to configure a complex query. In the Sell Your Item flow, this is a complex query against the eBay product catalog. Currently, this type of search is available in Consumer Electronics categories only. In this type of search, you specify values for multiple attributes, like Brand and Resolution (i.e., number of megapixels). This retrieves a list of matching products. This approach is useful when the user does not know the part number, or a product does not have a single, distinguishing feature that is easy to search on. For example, searching for a digital camera based solely on the brand would likely yield far too many results to be useful. Searching on the brand, product line, and resolution will retrieve a much shorter list of results. Alternatively, you can search on a particular keyword that appears in a product's title or Item Specifics. For this, you use GetProductSearchResults and and pass in one or more text strings (with optional wildcards) in ProductSearch.QueryKeywords. When you use a keyword query, the search criteria are not restricted to the results of a product search page or product finder, so the criteria are not tied to a particular characteristic set. This means you can search across multiple characteristic sets using the same query. This is useful when the user wants to broaden their search across multiple categories. For example, a seller who sells Jazz books, Jazz CDs, and Jazz movies may want to search for "Bird" across multiple categories. Specify the characteristic set IDs of interest by using CharacteristicSetIDs. GetProductSearchResults returns a list of matching products, if any. Each product is represented as a list of attributes (Item Specifics) plus other identifying information, such as a product ID and a stock photo. Once the user selects a product from the list (this may require a call to GetProductFamilyMembers to retrieve additional products to choose from), pass its ID in a GetProductSellingPages request to retrieve more detailed information about each product, including a set of optional Item Specifics that the seller can use in addition to the pre-filled Item Specifics (see GetProductSellingPages). To use this data in a listing, pass the product ID and the optional Item Specifics in the seller's listing request (AddItem).

Searches for Pre-filled Item Information within one or more characteristic sets. Use the response from GetProductSearchPage or GetProductFinder to determine the attributes that can be used as criteria for the search. After a user selects a product by its ID, use the ID as input to GetProductSellingPages. This call also supports batch requests (i.e., searching for several products in the same call).

Specifies the keywords or attributes that make up the product query, with pagination instructions. ProductSearch is a required input. To search for multiple different products at the same time (i.e., to perform a batch search), pass in multiple ProductSearch properties. GetProductSearchResults Yes GetProductSearchResults performs a product search and collects the results. Result attributes for each product/product family are grouped and identified with a product ID. If more matches are found than the max amount specified per family, only the product family information is returned. In this case, call GetProductFamilyMembers to retrieve more products within the same family. Container for one or more DataElement fields containing supplemental helpful data. A DataElement field is an HTML snippet that specifies hints for the user, help links, help graphics, and other supplemental information that varies per characteristic set. Usage of this information is optional and may require you to inspect the information to determine how it can be applied in an application. Also returned with warnings when no matches are found. GetProductSearchResults Always Contains the attributes and product details that match the attributes or query keywords passed in the request. Always returned when product search results are found. GetProductSearchResults Always Retrieves information that describes how to present catalog product information to a seller. Use this information to present users with the equivalent of the Item Specifics portion of the eBay Title and Description pages and to validate user-specified values for eBay attributes on the client before including them in an AddItem call or related calls. The data contains a list of all the attributes that are applicable for one or more requested products, along with related meta-data. The meta-data specifies the pre-filled values of each attribute, the possible values of attributes that are not pre-filled, the logic for presenting the attributes to a user, and rules for validating the user's selections. Use the results in combination with GetAttributesXSL to render the Item Specifics in a graphical user interface. See the eBay Web Services Guide for an overview of Pre-filled Item Information, details about searching for catalog products, and information about the ProductSellingPages content model.

Retrieves information that describes how to present catalog product information to a seller. Use this data when listing an item with Pre-filled Item Information.

Specifies the context in which the call is being executed, which will imply certain validation rules. Use this property to make sure you retrieve the appropriate version of product information and attribute meta-data when you are listing, revising, or relisting an item with Pre-filled Item Information. Valid values: SYI = Sell Your Item. Use before adding an item. Causes the response to include the latest product ID in the system (given an ID specified in the Products element) and the corresponding characteristic meta-data. RYI = Revise Your Item. Use this before revising an item. Causes the response to return the product ID, attribute data, and other data associated with the version of the product that you pass in the Products element. This is useful in case the product ID or associated data has changed in the system since the item was originally listed. When revising an item, this helps you make changes that are consistent with the original listing. RELIST = Use this before relisting an item. Causes the response to include the latest product ID in the system (given an ID specified in the Products element) and the corresponding characteristic meta-data. (Same as SYI). GetProductSellingPages Yes A catalog product identifies a prototype description of a well-known type of item, such as a popular book. As this call supports batch requests, you can pass in an array of products to retrieve data for several products at the same time. GetProductSellingPages Yes Retrieves an XML string that describes how to present catalog product information to a seller. Use this information to present users with the equivalent of the Item Specifics portion of the eBay Title and Description pages and to validate user-specified values for eBay attributes on the client before including them in an AddItem call or related calls. Use the results in combination with GetAttributesXSL to render the Item Specifics in a graphical user interface. See the Developer's Guide for an overview of Pre-filled Item Information and details about searching for catalog products. A string containing a list of all the attributes that are applicable to the products specified in the request, along with related meta-data. The meta-data specifies the pre-filled values of each attribute, the possible values of attributes that are not pre-filled, the logic for presenting the attributes to a user, and rules for validating the user's selections. For backward compatibility, this data is in the same XML format that was used in the Legacy XML API so that you can apply the same Item Specifics XSL stylesheet to it. That is, individual elements are not described using the unified schema format. The data is based on the GetAttributesCS response (AttributeData), with additional information that is specific to catalog products. Product and attribute information is nested within a set of Product tags. The product-specific data is merged into the attribute data so that the same XSL stylesheet used to render the results of GetAttributeCS can be used to render catalog product data. See GetAttributesXSL. See the Attribute Meta-Data Model section of the eBay Web Services guide for information about each element in the ProductSellingPagesData string. Because the content is returned as a string, the XML markup elements are escaped with character entity references (e.g.,&lt;eBay&gt;&lt;Attributes&gt;...). See the appendices in the eBay Web Services guide for general information about string data types. GetProductSellingPages Always Requests a list of the cross-promotion rules associated with a specific referring item or store category.

Requests a list of the cross-promotion rules associated with a specific referring item or store category.

The unique ID of the referring item for which you want promotion rules. Specify a value for either ItemID or StoreCategoryID, never both. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetPromotionRules Conditionally The unique ID of the store category for which you want promotion rules. Specify a value for either ItemID or StoreCategoryID, never both. GetPromotionRules Conditionally The type of promotion rules to retrieve, either UpSell or CrossSell. GetPromotionRules Yes Returns a list of promotion rules associated with a specific item or store category. An array of upsell or cross-sell promotion rules associated with the item or category specified in the request. All rules in the array are either upsell or cross-sell, according to the value of PromotionMethod specified in GetPromotionRulesRequest. GetPromotionRules Always (Use GetItemRecommendations instead of GetRecommendations. GetItemRecommendations supports all the same features as GetRecommendations and adds support for batch requests.) Invokes one or more specified recommendation engines. These engines can examine potential item data that a seller has specified and return recommended changes or opportunities for improvement.

Deprecated soon. Please use GetItemRecommendations instead. Invokes one or more specified recommendation engines.

The listing flow for which the seller is seeking Listing Analyzer recommendations. Not applicable to results from other recommendation engines. The default flow is AddItem. GetRecommendations No Contains fields that describe the item for which you are seeking recommendations. If the Listing Analyzer recommendation engine is run, the applicable fields are the same as the fields for AddItem, ReviseItem, or RelistItem requests, as determined by the value specified in ListingFlow. The item ID (Item.ItemID) is required when the ListingFlow is ReviseItem or RelistItem. All other item fields are optional, even if listed as required for other calls. However, as some tips are dependent on the properties of the item, and as some properties have dependencies on other properties, we strongly recommend that you include all the item properties that will be included in the AddItem, ReviseItem, or RelistItem request. GetRecommendations Yes An ISBN value, UPC value, or eBay catalog product ID. Identifies Pre-filled Item Information that the seller wants to include in the listing. Only applicable for certain categories and only applicable when the value of ListingFlow is AddItem. Not applicable when the recommendation engine is ProductPricing. See the Developer's Guide for information on the categories that currently support usage of this field. Either ExternalProductID or Item.ProductListingDetails can be specified in the request, but not both. If the primary and secondary category are both catalog-enabled, this ID must be for a product associated with the primary category. If only one category is catalog-enabled, this ID must be for a product that is associated with the catalog-enabled category. GetRecommendations No Applicable when the ListingFlow is ReviseItem or RelistItem. Array of item properties that are being changed. See the Developer's Guide for rules on adding, modifying, and removing values when revising or relisting items. In release 439 and later, ModifiedFields is no longer required to revise field values, but it is still supported for backward compatibility. See the Developer's Guide for rules on adding, modifying, and removing values when revising or relisting items. GetRecommendations No An array of recommendation engines. If no engines are specified, all available recommendation engines will run. Certain input fields (such as Item.PrimaryCategory.CategoryID) are required in order to run all engines with no errors. GetRecommendations No Specifies the search string, consisting of one or more words to search for in the listing title. The words "and" and "or" are treated like any other word. Required when the Suggested Attributes engine is used. 350 (characters) GetRecommendations Conditionally Please use GetItemRecommendations instead of GetRecommendations. GetItemRecommendations supports all the same features as GetRecommendations and adds support for batch requests. GetRecommendations returns recommended changes or opportunities for improvement related to listing data that was passed in the request. Contains tips returned from the Listing Analyzer recommendation engine, if this engine was specified in the request (or if no engine was specified). GetRecommendations Reserved for future use. Contains pricing data returned from the Product Pricing engine, if this engine was specified in the request (or if no engine was specified). GetRecommendations Contains attribute suggestions returned from the Suggested Attributes engine, if this engine was specified in the request. The results include suggested attributes and values based on the primary category and a string you specify in the Query field. Suggestions may only be returned when the Suggested Attributes engine is specified alone. If you request recommendations by using multiple engines, suggested attribute data might not be returned. If attributes are returned with multiple values, the values are returned in order of rank (i.e., the value that best meets eBay's recommendation criteria is returned first). GetRecommendations Contains zero or more product titles and IDs returned from the Suggested Attributes engine, if this engine was specified in the request (or if no engine was specified). If applicable, use one of the suggested product IDs to list the item with Pre-filled Item Information. GetRecommendations Returns all of your application's authentication and authorization preferences and related data, such as the URLs that eBay should redirect users to after they complete the authentication and authorization process. This call must be authenticated using the application's username and password (not an authentication token).

Returns all of your application's authentication and authorization preferences and related data.

Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Returns all the authentication and authorization preferences and related data for the application. Display name for the application. When your application redirects users to eBay to complete the authentication and authorization process, eBay displays this value to identify your application to the user. GetReturnURL Always One or more sets of authentication preferences and other data that you have configured for your application (if any). Call SetReturnURL to configure this data. GetReturnURL Conditionally Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Returns a globally unique runame (unique identifier for an authentication data entry). This call must be authenticated using the application's username and password, rather than a token.

Returns a globally unique runame (unique identifier for an authentication data entry).

Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Optional value that is appended to the generated runame. GetRuName No Contains the generated runame (unique identifier for an authentication data entry). The generated globally unique runame. GetRuName Always Conducts a search for items on eBay based on a user-specified set of one or more keywords. Returns those item listings where the keywords appear in the title, subtitle, and (optionally) the description. The request includes various kinds of fields that control the output. Some fields (e.g., Query) are primary search criteria that let you specify data to match in listings. For example, you can search for all listings that include the word "Toy" in the title. Some fields (e.g., ItemTypeFilter) are secondary search criteria that let you further refine data to match in listings. For example, you can search for all toys that are listed as auctions. In general, the effect of secondary search fields is cumulative (using "AND" logic) unless otherwise specified. Some fields (e.g., TotalOnly) control what is actually returned in the result set. For example, you can search for all toys that are listed as Chinese auctions, but just retrieve the total count (not the listings themselves). Some fields (e.g., IncludeCondition) affect the data to retrieve for each listing in the result set. For example, for each toy returned in the result, you can also choose to see the toy's new or used condition. Some fields (e.g., Order) control the way the listings are organized in the response. For example, you can retrieve all the toy listings in chronological order, with the newest one first. Use the DetailLevel ItemReturnCategories to return the primary category and, if applicable, the secondary category. Use the DetailLevel ItemReturnAttributes (or ReturnAll) to return summary Item Specifics (only returned for categories that support summary Item Specifics in search results). Not applicable to eBay Express or Half.com.

Retrieves item listings based on keywords you specify. The keywords can include wildcards. The response is in the form of an array whose size and contents you specify, using a variety of input fields. You can filter the item listings returned using such criteria as the listing category, location, whether the item is listed in an ebay Store, and listing type. You can include or exclude specified sellers.

Limits the results based on each item's eligibility to appear on the mobile.de site. If false, excludes eligible items from search results. If true, queries for eligible items only. If not specified, the search results are not affected. Only applicable for items listed on the eBay Germany site (site ID 77) in subcategories of mobile.de search-enabled categories. GetSearchResults No A query that specifies a search string. The search string consists of one or more keywords to search for in the listing title and/or description. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for listings containing these words. You can use AND or OR logic by including certain modifiers. Wildcards (e.g., *) are also supported. Be careful when using spaces before or after modifiers and wildcards (+, -, or *). See the eBay Web Services Guide for a list of valid modifiers and examples. Query is not applicable in combination with ExternalProductID or ProductID. 350 (characters) GetSearchResults Conditionally Limits the result set to just those items listed in the specified category. You can use the ItemReturnCategories detail level. If you use the ItemReturnCategories detail level, the results include the primary category of retrieved items and, if applicable, the secondary category. Defaults to all categories if no category ID is specified. If the specified category ID does not match an existing category for the site, an invalid-category error message is returned. You must pass ProductID, Query, ExternalProductID, or CategoryID in the request. CategoryID can be used in combination with Query. It is not allowed with ExternalProductID, ProductID, or when SearchRequest is used. If you pass CategoryID without Query, it must specify a leaf category ID. That is, it cannot be a meta-category ID (e.g., 267 for "Books"). 10 GetSearchResults Conditionally Secondary search criterion that checks item descriptions for keywords that match the query, limits the search results to only charity items, limits the result set to those items with PayPal as a payment method, and/or provides other criteria to refine the search. Not allowed with UserIdFilter (IncludeSellers or ExcludeSellers). GetSearchResults No Limits the result set to just those items where the price is within the specified range. The PriceRangeFilterType includes a minimum and a maximum price. GetSearchResults No Limits the result set to just those items whose location is within a specified distance of a postal code. The ProximitySearchType includes a maximum distance and a postal code. GetSearchResults No Filters items based on the ListingType set for the items. If you search for Store Inventory items, you should use values in ItemTypeFilter instead of StoresFixedPrice. If ItemTypeFilter is not specified (or if the AllItemTypes value of ItemTypeFilter is specified), all listing types can be returned unless another relevant filter is specified. You cannot use GetSearchResults to search eBay Express. GetSearchResults No AllItems Limits the listings in the result set based on whether they are in the Gallery. The choices are items in the Gallery or Gallery and non-Gallery items. GetSearchResults No Limits the the result set to just those items listed by one or more specified sellers or those items not listed by the one or more specified sellers. GetSearchResults No Limits the result set to just those items that meet location criteria: listed in a specified eBay site, location where the seller has the item, location from which the user is searching, and/or items listed with a specified currency. You cannot use GetSearchResults to search eBay Express. GetSearchResults No Limits the result set to just those items that meet criteria related to eBay Stores sellers and eBay Stores. Use this to retrieve items listed in a particular seller's eBay Store or in all store sellers' eBay Stores. GetSearchResults No Specifies the order in which listings are returned in a result set. Listings may be sorted by end time, start time, and in other ways listed in the SearchSortOrderCodeType. Controls the way the listings are organized in the response (not the details to return for each listing). For most sites, the default sort order is by items ending soonest. Store Inventory listings are usually returned after other listing types, regardless of the sort order. GetSearchResults No Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and which page of data to return. Controls the way the listings are organized in the response (not the details to return for each listing). GetSearchResults No A query consisting of a set of attributes (Item Specifics). Use this kind of query to search against the Item Specifics in listings (e.g., to search for a particular shoe size). If the query includes multiple attributes, the search engine will apply "AND" logic to the query and narrow the results. Use GetProductFinder to determine the list of valid attributes and how many are permitted for the specified characteristic set. Retrieves items along with any buying guide details that are associated with the specified product finder. Applicable in combination with the Query argument. Cannot be used in combination with ProductID or ExternalProductID. GetSearchResults No An exclusive query to retrieve items that were listed with the specified eBay catalog product. You must pass ProductID, Query, ExternalProductID, or CategoryID in the request. If you use ProductID, do not use Query, ExternalProductID, or CategoryID. GetSearchResults Conditionally An exclusive query to only retrieve items that were listed with the specified ISBN or UPC. Only applicable for items that were listed with Pre-filled Item Information in media categories (Books, Music, DVDs and Movies, and Video Games). You must pass ProductID, Query, ExternalProductID, or CategoryID in the request. If you use ExternalProductID, do not use Query, ProductID, or CategoryID. GetSearchResults Conditionally Retrieves statistical information about categories that contain items that match the query. Can also cause the result to include information about buying guides that are associated with the matching categories. Does not control the set of listings to return or the details to return for each listing. GetSearchResults No Retrieves the total quantity of matching items, without returning the item data. See PaginationResult.TotalNumberOfEntries in the response. If TotalOnly and Categories.CategoriesOnly are both specified in the request and their values are inconsistent with each other, TotalOnly overrides Categories.CategoriesOnly. That is, if TotalOnly is true and Categories.CategoriesOnly is false, the results include matching categories but no item data or buying guides. If TotalOnly is false and Categories.CategoriesOnly is true, the results include matching categories, item data, and buying guides. If TotalOnly is not specified, it has no logical effect. GetSearchResults No Limits the results to items ending within a time range. EndTimeFrom specifies the beginning of the time range. Specify a time in the future. If you specify a time in the past, the current time is used. If specified, EndTimeTo must also be specified (with a value equal to or later than EndTimeFrom). Express the time in GMT. Cannot be used with the ModTimeFrom filter. GetSearchResults Conditionally Limits the results to items ending within a time range. EndTimeTo specifies the end of the time range. If specified, EndTimeFrom must also be specified (with a value equal to or earlier than EndTimeTo). Express the time in GMT. Cannot be used with the ModTimeFrom filter. GetSearchResults Conditionally Limits the results to active items whose status has changed since the specified time. Specify a time in the past. Time must be in GMT. Cannot be used with the EndTime filters. GetSearchResults No When passed with a value of true, limits the results to Get It Fast listings. GetSearchResults No Ignored if Store-related values in ItemTypeFilterCodeType are used as input filters. Using values in ItemTypeFilterCodeType is preferable to using StoresFixedPrice. StoresFixedPrice controls whether or not to use the Store Inventory format as a filtering criterion. For US, Canada, and Motors: The StoresFixedPrice input field does not currently work for these sites. For all other sites: If true, the results only include Store Inventory listings (with no listings in other formats). If false, the results only include listings in other formats (with no Store Inventory listings). If omitted (the default), this filter is not applied at all, so all formats can be returned (depending on other criteria you pass in the request). In this case, Store Inventory listings appear after all other matching auction and basic fixed price listings. You can use this filter regardless of whether you are searching in eBay Stores. If you pass StoresFixedPrice in the same request with StoreSearchFilter or ItemTypeFilter, "AND" logic may be applied, and you might not get the desired results. For example, if you specify StoresFixedPrice=true and ItemTypeFilter=AuctionItemsOnly, the call will succeed but no listings will be returned (because no listings can use both auction and Store Inventory formats). This is why it is recommended that you use values in ItemTypeFilterCodeType instead of StoresFixedPrice. GetSearchResults No ObsoleteSoon Limits the results to items that accept a specific payment method or methods. GetSearchResults No Optional tag that currently accepts only one value for this call: Coarse. Other values return an error. Specify the value Coarse if you want only the following fields to be returned for items (if applicable to the result set): ItemID, Title, ViewItemURL, ListingType, StartTime, EndTime, BuyItNowPrice, CurrentPrice, ConvertedCurrentPrice, LocalizedCurrentPrice, Currency, ShippingType, DefaultShippingCost, Country, PostalCode, and any tags resulting from the detail level you specify. Controls the details to return for each listing (not the set of listings that match the query). GetSearchResults No Expands search results when a small result set is returned. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, then if you specify true for this tag, the search results are expanded. Specifically, the search returns items (if there are matches) in one or more of the following containers: InternationalExpansionArray (for items available from international sellers), FilterRemovedExpansionArray (items that would be returned if filters such as PriceRangeFilter are removed), and AllCategoriesExpansionArray (for items available if category filters are removed). Maximum number of items returned in each expansion container is 6 to 10. GetSearchResults No Limits the results to only those listings for which Item.LotSize is 2 or greater. GetSearchResults No Restricts listings to return only items that have the Ad Format feature. If true, the values of ItemTypeFilter, StoresFixedPrice, and StoreSearchFilter are ignored (if they are specified). That is, "AND" logic is not applied. GetSearchResults No Limits the results to listings that offer a certain number of items matching the query. If Lot is also specified, then Quantity is the number of lots multiplied by the number of objects in each lot. Use QuantityOperator to specify that you are seeking listings with quantities greater than, equal to, or less than Quantity. GetSearchResults No Limits the results to listings with quantities greater than, equal to, or less than Quantity. Controls the set of listings to return (not the details to return for each listing). GetSearchResults No Limits the results to those of a particular seller business type such as commercial or private. GetSearchResults No If true, limits the results to digitally delivered good only. If false, this flag is ignored (i.e., false is the same as not specifying the flag at all). GetSearchResults No For eBay Germany only. If true, each item in the result set can also include the item condition attribute (e.g., New or Used) in the ItemSpecific property of the response. An item only includes a condition attribute in the response if the seller filled in the Item Condition in the Item Specifics section of the listing. (That is, the condition attribute is not returned if the seller only put the word "New" in the listing's title but did not specify the condition in the listing's Item Specifics.) Controls the details to return for each listing (not the set of listings that match the query). Note: This field does not control whether to retrieve only new or used items. In some categories, you can use a product finder search (SearchRequest) to only retrieve new or used items. GetSearchResults No If true, each item in the result set also includes information about the seller's feedback. Controls the details to return for each listing (not the set of listings that match the query). GetSearchResults No (in) Restricts listings to return only items that support the specified nonprofit charity organization. Retrieve CharityID values with GetCharities. GetSearchResults No Include local items in returning results near this postal code. This postal code is the basis for local search. GetSearchResults No Response contains the item listings that have the specified keyword(s) in the title, sub-title, and (optionally) the description. If the request uses any of the optional filtering properties, the item listings returned are those containing the keyword(s) and meeting the filter criteria. Not applicable to eBay Express or Half.com. Contains the returned item listings, if any. The data for each listing is returned in an ItemType object. GetSearchResults Conditionally Indicates the maximum number of ItemType objects that can be returned in SearchResultItemArray for any given call. GetSearchResults Always Indicates the page of data returned by the current call. For instance, for the first set of items can be returned, this field has a value of one. GetSearchResults Always Indicates whether there are more items, not yet returned, that match the search criteria. GetSearchResults Always Indicates the results of the pagination, including the total number of pages of data that can be returned and the total number of items that can be returned. GetSearchResults Always Statistical information about categories that contain items that match the query, if any. Returns empty if no matches are found or when the Categories filter was not passed in the request. (For categories associated with specific items, see items returned in each search result.) Shows the distribution of items across each category. GetSearchResults Always Contains URLs and other information about relevant buying guides (if any), as well as the site's buying guide hub. Unavailable in the Sandbox environment. Buying guides are useful to buyers who do not have a specific product in mind. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. Only returned for product finder searches (using SearchRequest.SearchAttributes) and for searches that retrieve matching categories along with item data (using Categories.CategoriesOnly=false). GetSearchResults Conditionally No longer returned as of mid-February 2006 (because Store Inventory listings are no longer limited to searches within eBay Stores). Used to contain items that were listed in the Store Inventory Format, if the request specified that ExpandSearch was true. GetSearchResults Conditionally Obsolete Can be returned if the request specifies that ExpandSearch is true. Provides additional search results when a small result set would have been returned with the original search. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, and ExpandSearch is true, the search results are expanded to include (if matching the query) the InternationalExpansionArray container for items, as well as other containers. The InternationalExpansionArray container contains items available from international sellers. GetSearchResults Conditionally Can be returned if the request specifies that ExpandSearch is true. Provides additional search results when a small result set would have been returned with the original search. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, and ExpandSearch is true, the search results are expanded to include (if matching the query) the FilterRemovedExpansionArray container for items, as well as other containers. The FilterRemovedExpansionArray container contains items that would be returned if filters such as PriceRangeFilter are removed. GetSearchResults Conditionally Can be returned if the request specifies that ExpandSearch is true. Provides additional search results when a small result set would have been returned with the original search. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, and ExpandSearch is true, the search results are expanded to include (if matching the query) the AllCategoriesExpansionArray container for items, as well as other containers. The AllCategoriesExpansionArray container contains items available if category filters are removed. GetSearchResults Conditionally Suggestion for a different spelling of the search term or terms, along with the number of matching items that would have been returned if the suggestions had been used. The suggestions are given in Text tags and the suggestion for the first word is given before the suggestion for subsequent words. Suggestions are based on correctly-spelled terms in items, so suggestions vary over time and depend on whether a word or word combination is in one or more items. GetSearchResults Conditionally Retrieves brief details about active items that are listed on eBay Express, eBay catalog products that have been used to pre-fill data in these items, and a histogram that shows the distribution of items and catalog products across Express departments, aisles, and/or product types. This call only returns Express data for the site associated with the site ID that you specify in the request URL (for the SOAP API) or the X-EBAY-API-SITEID header (for the XML API). For example, if you specify site ID 0, then data for Express US is returned. Currently, this call is only supported for site ID 0 (Express US). The Sandbox does not support GetSearchResultsExpress. You can configure the call to retrieve only the item data, only the catalog product data, only the histogram, or any combination of these results. By default, the call returns brief summaries of each. Item Results: For each item returned (if any), the response includes a brief set of details, such as the item price (including shipping). You can retrieve more or fewer details about each item by using the ItemDetails field. To retrieve other details about a given item, use a call like GetSellerList or GetItem. Catalog Product Results: For each eBay catalog product returned (if any), the response includes a brief set of details, such as the minimum and maximum price of listings that have been pre-filled based on that product. You can retrieve more or fewer details about each product by using the ProductDetails field. Histogram Results: Instead of grouping items by category, the Express search engine groups items into domains. A domain is a set of items to which Express can apply a common set of search rules. Express supports three kinds of domains: Product types, aisles, and departments, like a typical department store. (The fact that we call these "domains" is not important to buyers and sellers, but it can be helpful to understand the domain relationships when you are working with the API.) Listings with similar properties are classified into product type domains. For example, "DVDs & Movies" is a product type domain. Think of a product type as a type of good or service that can be purchased and as a leaf domain (which cannot be the parent of other domains). Note: An Express product type is not the same as an eBay catalog product. Some Express product types are associated with eBay catalog products, but other Express product types are not. When multiple product types share a common theme, Express groups them into an aisle or a department. For example, the Men's Jeans product type can be grouped with Men's Pants into a Men's Clothing aisle. When multiple aisles share a common theme, Express groups them into departments. For example, the Men's Clothing aisle can be grouped with a Men's Accessories aisle to form an Apparel & Accessories department. If no groups make sense, a product type can stand alone without being grouped. For example, "DVDs & Movies" would not be grouped with other product types like Men's Jeans, so "DVDs & Movies" has no parent aisle or department. (From a user's perspective, this product type is elevated to look like a department, but in the API it is still classified as a product type.) Similarly, an aisle can stand alone without being grouped with other aisles into a department. See <a href="http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context= eBay_XML_API&topic=ExpressSearch" target="_blank">Searching and Browsing eBay Express</a> for more information about departments, aisles, and product types. This call returns a histogram that shows the number of items and catalog products that were found in each department, aisle, and/or product type that matches your search criteria. The domain names and groupings are subject to change. They are determined by the Express search engine based on the items that are currently listed on Express as well as historical buyer behavior. This means you need to call GetSearchResultsExpress to determine the current domain names and their hierarchical relationships. Note: A domain is a search notion only. That is, items are not stored in domains on eBay, and domains are not equivalent to eBay categories (although Express may choose to organize and name some domains to match eBay categories). Search Tips: <ul> <li>Use either Query, ProductReferenceID, or the ExternalProductID fields to search for specific items and/or products. See the descriptions below for information about using these fields. (Only one of these query formats can be used per request.)</li> <li>Use DepartmentName, AisleName, and/or ProductTypeName to browse or search within a particular domain. You can also specify the value "Express" in DepartmentName to retrieve a complete list of all available department, aisle, and product type names.</li> <li>Use one or more filters like HighestPrice to refine the search.</li> <li>Use sort options like ItemSort to control the order in which the results are returned.</li> <li>Use pagination options like EntriesPerPage to control how many results to return at a time.</li> <li>Use verbose controls like ItemDetails to specify the data to return within each result.</li> </ul> The item results, catalog product results, and histogram results do not provide references to each other. That is, the items don't indicate which domains they were found in, and the histogram doesn't specify which items were counted. However, you can infer these relationships by modifying your search parameters. For example, once you determine which domains match your query, you can call GetSearchResultsExpress again to browse or search each of those domains to find out which items they contain.

Retrieves brief details about active items that are listed on eBay Express, eBay catalog products that have been used to pre-fill data in these items, and a histogram that shows the distribution of items and catalog products across Express departments, aisles, and/or product types.

A free-text query that retrieves items, information about eBay catalog products that were used to list the items, and/or applicable domain details. For a quick, targeted search, use keywords that best fit the item you're looking for. You can also search by brand name or descriptive features. The search engine checks all specified keywords against the item title, description, eBay category, Item Specifics, and/or Pre-filled Item Information. (Express does not necessarily check all Item Specifics defined on the item.) The exact combination of fields that are checked for any given set of keywords varies by a number of factors that are not disclosed in this documentation. Specify at least two characters when you use Query. If you specify multiple words, AND logic is used. The keywords can be specified any order. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for listings containing these words. You can control AND or OR logic by including certain modifiers. Wildcards (e.g., *) are also supported. Be careful when using spaces before or after modifiers and wildcards (+, -, or *). These are the same modifiers that GetSearchResults supports. See "Searching by Keywords" in the eBay Web Services Guide for a list of valid modifiers and examples. Modifiers do not count in the 2-character minimum. Alternatively, you can specify an item ID to retrieve a specific item's Express search details. To search by ISBN or UPC, use ExternalProductIDType and ExternalProductIDValue instead. The Query, ProductReferenceID, and ExternalProductID query formats are mutually exclusive. That is, they cannot be used together in the same request. At least one of Query, ProductReferenceID, ExternalProductIDValue (and Type), SellerID, DepartmentName, AisleName, or ProductTypeName is required. 350 GetSearchResultsExpress Conditionally The combination of ExternalProductIDType and ExternalProductIDValue create a query that only retrieves items that were listed with Pre-filled Item Information in categories that support ISBN or UPC codes. ExternalProductIDType identifies whether the search is by ISBN or UPC. If specified, also specify the ISBN or UPC code in ExternalProductIDValue. The Query, ProductReferenceID, and ExternalProductID query formats are mutually exclusive. That is, they cannot be used together in the same request. At least one of Query, ProductReferenceID, ExternalProductIDValue (and Type), SellerID, DepartmentName, AisleName, or ProductTypeName is required. Note: The ExternalProductID type and value structure is flat to support REST API requests in the future. GetSearchResultsExpress Conditionally An ISBN or UPC code (depending on ExternalProductIDType) for the eBay catalog product that you are searching for. Only valid when ExternalProductIDType is specified. 15 GetSearchResultsExpress Conditionally The global reference ID for an eBay catalog product. eBay catalog products provide stock information that sellers can use to pre-fill Item Specifics and other listing details. Use this query to retrieve items that were listed with any version of the catalog product. To determine valid reference IDs, call GetSearchResultsExpress without using this value. The IDs that match the query (if any) are returned in ProductArray.Product.ProductReferenceID fields. Note: This value is not the same as the ProductID used in AddItem and related calls. You cannot use this call or the catalog search calls to determine a relationship between ProductReferenceID and ProductID. The Query, ProductReferenceID, and ExternalProductID query formats are mutually exclusive. That is, they cannot be used together in the same request. At least one of Query, ProductReferenceID, ExternalProductIDValue (and Type), SellerID, DepartmentName, AisleName, or ProductTypeName is required. GetSearchResultsExpress Conditionally A department is a grouping of aisles and/or product types that share a common theme. This filter limits the search to the specified Express department. If not specified, this filter is ignored by the search engine. You can specify the value "Express" (without quotes) as the department name to retrieve all departments on Express. With this use case, the ItemArray and ProductArray nodes aren't returned. The valid department names are returned in the Histogram.Department.DomainDetails.Name fields. When DepartmentName=Express, you can only specify HistogramSort and/or HistogramDetails. Set HistogramDetail to Fine to also retrieve all aisles and product types. Do not specify ItemDetails or ProductDetails at all in the request. (Setting the values to None will return an error). Also do not specify any other query, pagination, price, or sorting fields in the request. The Query, ProductReferenceID, and ExternalProductID query formats are mutually exclusive. That is, they cannot be used together in the same request. At least one of Query, ProductReferenceID, ExternalProductIDValue (and Type), SellerID, DepartmentName, AisleName, or ProductTypeName is required. Note: The potential max length will be documented in a future release. GetSearchResultsExpress No An aisle is a grouping of product types that share a common theme. This filter limits the search to the specified Express aisle. If not specified, this filter is ignored by the search engine. See DepartmentName for information about how to retrieve all available department, aisle, and product type names. The valid aisle names are returned in the Histogram.Department.Aisle.DomainDetails.Name fields. At least one of Query, ProductReferenceID, ExternalProductIDValue (and Type), SellerID, DepartmentName, AisleName, or ProductTypeName is required. Optionally, both DepartmentName and AisleName can be specified in the same request. In this case, the search engine treats the combination as a fully qualified aisle name (and it returns an error if the combination is invalid). GetSearchResultsExpress Conditionally A product type is a type of good or service that can be purchased. This filter limits the search to the specified Express product type. If not specified, this filter is ignored by the search engine. Note: Express product types are not eBay catalog products. This field does not support eBay catalog product names or IDs. See DepartmentName for information about how to retrieve all available department, aisle, and product type names. The valid product type names are returned in Histogram.Department.Aisle.ProductType.DomainDetails.Name fields. Optionally, DepartmentName and/or AisleName can be specified in the same request with ProductTypeName. In this case, the search engine treats the combination as a fully qualified product type name (and it returns an error if the combination is invalid). GetSearchResultsExpress No Specifies the order of the data in the histogram (if any). Controls the way the histogram data is organized in the response (not the details to return). If not specified, the default sort order is ItemCount. This option has no effect on how item or product results are sorted. Histogram, item, and product results are sorted independently. Note: If you want to sort the results by criteria that eBay has not defined, retrieve the desired histogram data and then sort the results locally in your application. ItemCount GetSearchResultsExpress No Specifies the order in which listings (if any) are returned in the result set. If not specified, the items are sorted by relevance (as determined by eBay). If you choose to sort by total cost, a PostalCode must also be specified (so that eBay can calculate the shipping cost as part of the total cost for each item). Controls the way the data is organized in the response (not the details to return). This option has no effect on how histogram or product results are sorted. Histogram, item, and product results are sorted independently. Note: If you want to sort the results by criteria that eBay has not defined, retrieve all available pages and then sort the results locally in your application. Relevance GetSearchResultsExpress No Specifies the order in which Express products are returned in a result set. If not specified, the products are sorted by sales rank (bestselling first). This option has no effect on how histogram or item results are sorted. Histogram, item, and product results are sorted independently. Note: If you want to sort the results by criteria that eBay has not defined, retrieve all available pages and then sort the results locally in your application. Controls the way the data is organized in the response (not the details to return). SalesRank GetSearchResultsExpress No A filter that limits the results to items with a SellingStatus.CurrentPrice value lower than this value. For example, if you specify 10.01, the results will include items with a CurrentPrice of 10.00 or lower. Use without LowestPrice to specify a maximum price, or use with LowestPrice to define a price range that bounds the results. Must be higher than LowestPrice if both are specified. If not specified, no maximum price filter is applied to the query. You can specify any double value, but in practice the highest price of any item on Express is USD 10000 for Express US and (in the future) EUR 10000 for Express Germany. If you specify a value of 0.0 or lower, this filter is ignored. See "Data Types" in the eBay Web Services Guide for information about specifying double values. Does not control the order in which items are returned. (To sort by highest total price, use ItemSort.) GetSearchResultsExpress Conditionally A filter that limits the results to items with a SellingStatus.CurrentPrice value equal to or higher than this value. For example, if you specify 6.00, the results will include items with a CurrentPrice of 6.00 or higher. If specified, HighestPrice must also be specified; otherwise, the lowest price filter is ignored. Must be lower than HighestPrice. If not specified or if the value is less than 0.0, no minimum price filter is applied to the query. You can specify any double value, but in practice the highest price of any item on Express is USD 10000 for Express US and (in the future) EUR 10000 for Express Germany. See "Data Types" in the eBay Web Services Guide for information about specifying double values . Does not control the order in which items are returned. (To sort by lowest total price, use ItemSort.) GetSearchResultsExpress No A filter that limits the results by the item condition. If not specified, the default is New. If the item is listed in a category that does not normally require the condition to be specified (like Event Tickets), the item is returned regardless of this condition setting. New GetSearchResultsExpress No A filter that limits the search to a particular seller's listings that are included on Express. Retrieves all of the seller's eligible items, without consolidating (deduping) similar items into single representative results. If specified, you can only search within one seller's listings per call. (It is not possible to exclude a particular seller's listings from the search.) If not specified, the engine searches across all listings on Express. If the seller has no items listed on Express, no results are returned. GetSearchResultsExpress No Postal code of the buyer. For the US site, this is a 5-digit zip code. (Other sites may support longer alphanumeric values in the future.) The postal code enables Express to calculate the item's default shipping cost based on the buyer's postal code, the postal code defined on the item, and the cost of the default shipping service that the seller specified in the listing. The default shipping cost is returned in the Item.ShippingDetails.DefaultShippingCost field. If not specified, items with calculated shipping will return an Item.ShippingDetails.ShippingRateErrorMessage string that indicates that a postal code is needed to calculate shipping. Required if ItemSort is set to LowestTotalCost or HighestTotalCost (because the total cost calculation depends on the shipping cost calculation). This is not a query or filter, so it has no effect on which items or products are returned. 5 GetSearchResultsExpress Conditionally Controls the amount of statistical data to return in the response. If not specified, the default is Coarse. This setting is not a filter that limits the search; it only configures how much detail to retrieve in the resulting histogram. This setting has no effect on the product or item details. Coarse GetSearchResultsExpress No Selects the set of fields to retrieve for each catalog product that matches the query. If not specified, the default is Coarse. This setting is not a filter that limits the search; it only configures which fields to retrieve for each product found. This setting has no effect on the histogram or item details. Coarse GetSearchResultsExpress No Selects the set of fields to retrieve for each item that matches the query. If not specified, the default is Coarse. This setting is not a filter that limits the search; it only configures which fields to retrieve for each item found. This setting has no effect on the histogram or product details. Coarse GetSearchResultsExpress No The maximum number of entries to return in the ProductArray or ItemArray. That is, if you specify 10, then up to 10 products and up to 10 items are returned in the current call's response. If the number of entries found is less than the value specified in EntriesPerPage, then that number of entries is returned instead. For example, if you specify 10, Express might only return 4 products and 9 items (if no more matches are found). If not specified, the default is 15. 1 200 15 GetSearchResultsExpress No Specifies the number of the page of data to return in the current call. If not specified, the default is 1 (the first page). 1 1 GetSearchResultsExpress No The GetSearchResultsExpress response contains the listings that match the query or ID specified in the request, related eBay catalog product information, and a histogram showing the the quantity (count) of matching items in Express departments, aisles, and product types. The results may be limited by filters that were specified in the request. Indicates the quantity of items and catalog products that fall into departments, aisles, and/or product types that match the criteria in the request. The sort order is controlled by the value of HistogramSort in the request. Only returned when matching data is found and HistogramDetails is Coarse (the default) or Fine. When HistogramDetails==Coarse and no DepartmentName, AisleName, or ProductTypeName is specified in the request, Express only returns histogram details for departments. In this particular case, Express returns no histogram details when no departments match the request. This could occur when Express only finds matching results in stand-alone product types or stand-alone aisles (because they aren't grouped into departments). GetSearchResultsExpress Conditionally Contains a list of items on Express that match all the criteria specified in the request. The sort order is controlled by the value of ItemSort in the request. Only returned when matching data is found and ItemDetails is Coarse (the default) or Fine. If the same seller has listed multiple items with the same title and costs, only one of those items is returned by default. This is treated as a consolidated (deduped) search result item that represents the seller's other, identical items. If you want to retrieve all duplicates for an item, pass the seller's user ID in the SellerID field in the request. Use the results to identify items with duplicate titles and costs. Items can belong to multiple departments, aisles, or product types at any given time, and this information is not stored or returned in the item data. To determine which items are currently available in a given domain, specify the DepartmentName, AisleName, or ProductTypeName in the request. GetSearchResultsExpress Conditionally Contains a list of eBay catalog products have been used to pre-fill listings that match the criteria specified in the request. The sort order is controlled by the value of ProductSort in the request. Only returned when matching data is found and ProductDetails is Coarse (the default) or Fine. To determine which products are currently available in a given domain, specify the DepartmentName, AisleName, or ProductTypeName in the request. GetSearchResultsExpress Conditionally Indicates the number of item and product results per page that you requested. To determine how many items or products were actually returned, count the number of Item nodes in ItemArray (if any) and the number of Product nodes in ProductArray (if any). 1 200 GetSearchResultsExpress Always Indicates the page of data returned by the current call. 1 GetSearchResultsExpress Always If true, there are additional item and/or product results (on higher-numbered pages) that match the query. To retrieve them, call GetSearchResultsExpress again and increment the page number or specify a higher value for EntriesPerPage in the request. GetSearchResultsExpress Always Contains the inputs that control the items that are returned for seller events. This includes time-based filtering on the start time, end time, and/or modification time of the item listings.

Retrieves price changes, item revisions, description revisions, and other changes that have occurred within the last 48 hours related to a seller's eBay listings. Input is the user ID for the seller whose events are returned. GetSellerEvents returns zero, one, or multiple item events. The result set is filtered to include only events for those items that start, end, or are modified within a span of time delineated by input values.

dl eBay user ID for the seller whose events are to be returned. If not specified, retrieves events for the user identified by the authentication token passed in the request. GetSellerEvents No Describes the earliest (oldest) date to use in a date range filter based on item start time. Must be specified if StartTimeTo is specified. Either the StartTime, EndTime, or ModTime filter must be specified. GetSellerEvents Conditionally Describes the latest (most recent) date to use in a date range filter based on item start time. Must be specified if StartTimeFrom is specified. Either the StartTime, EndTime, or ModTime filter must be specified. GetSellerEvents Conditionally Describes the earliest (oldest) date to use in a date range filter based on item end time. Must be specified if EndTimeTo is specified. Either the StartTime, EndTime, or ModTime filter must be specified. GetSellerEvents Conditionally Describes the latest (most recent) date to use in a date range filter based on item end time. Must be specified if EndTimeFrom is specified. Either the StartTime, EndTime, or ModTime filter must be specified. GetSellerEvents Conditionally Describes the earliest (oldest) date to use in a date range filter based on the time an item's record was modified. Must be specified if ModTimeTo is specified. Either the StartTime, EndTime, or ModTime filter must be specified. GetSellerEvents Conditionally Describes the latest (most recent) date to use in a date range filter based on the time an item's record was modified. Must be specified if ModTimeFrom is specified. Either the StartTime, EndTime, or ModTime filter must be specified. GetSellerEvents Conditionally Specifies that only new items are to be returned. NewItemFilter is an optional input. GetSellerEvents No Specifies whether to include WatchCount in Item nodes returned. WatchCount is the number of watches buyers have placed on the item from their My eBay accounts. GetSellerEvents No Contains the items returned by the call. Items for which a seller event has occurred (and that meet any filters specified as input) are returned in an ItemArrayType object, within which are zero, one, or multiple ItemType objects. Each ItemType object contains the detail data for one item listing. Indicates the latest (most recent) date for any date-based filtering specified as input. Specifically, this field contains the value you specified in the StartTimeTo, EndTimeTo, or ModTimeTo filter, if you used a time filter in the request. If no time filter was specified, TimeTo returns the current time. GetSellerEvents Always none, ReturnAll Collection of Item objects, each of which represents an item listing that incurred the type of seller event change specified in the call's inputs. Returns empty if the seller has no item events within the time window indicated in the request. GetSellerEvents Always none, ReturnAll Requests a list of items a seller has listed for auction. Use no DetailLevel to return brief item information (ItemID, StartTime, and EndTime only). Use the DetailLevel ReturnAll to return all information on the item, including Item.Description. Use ItemReturnDescription to return a shorter item description (see the eBay Web Services Guide for details).

Retrieves a list of the items a specified seller has listed on eBay. Input is the ID for the seller whose items are returned. Returns an array of zero, one, or multiple items for that seller. Inputs are provided to filter the returned items to just those that end within a specified date range or those items for which the listings start within a date range. A special set of inputs is provided to retrieve the list of items in smaller, more manageable chunks, or pages.

dl Specifies the seller whose items will be returned. UserID is an optional input. If not specified, the requesting user is the seller whose items are returned. GetSellerList No Reserved for future use. Specifies the earliest (oldest) date to use in a date range filter based on item end time. Specify either the end time range or start time range filter in every request. GetSellerList Conditionally Specifies the latest (most recent) date to use in a date range filter based on item end time. Must be specified if EndTimeFrom is specified. GetSellerList Conditionally Specifies the order in which returned items are sorted (based on the end dates of the item listings). Valid values: 0 = No sorting 1 = Sort in descending order 2 = Sort in ascending order GetSellerList No Specifies the earliest (oldest) date to use in a date range filter based on item start time. Specify either the end time range or start time range filter in every request. GetSellerList Conditionally Specifies the latest (most recent) date to use in a date range filter based on item start time. Must be specified if StartTimeFrom is specified. GetSellerList Conditionally Contains the data controlling the pagination of the returned values: how many items are returned per page of data (per call) and the number of the page to return with the current call. GetSellerList Conditionally Specifies the subset of item and user fields to return. See GetSellerList in the eBay Web Services guide for a list of the fields that are returned for each granularity level. For GetSellerList, use DetailLevel or GranularityLevel in a request, but not both. For GetSellerList, if GranularityLevel is specified, DetailLevel is ignored. GetSellerList No Specifies a set of seller SKUs to use as a filter. Only items with the specified SKUs are returned. Do not specify this tag if you do not want to filter by SKU. Corresponds to the SKU property that is part of ItemType and that can be provided when, for example, you use the AddItem call. GetSellerList No Specifies whether to include WatchCount in Item nodes returned. WatchCount is only returned with DetailLevel ReturnAll. GetSellerList No Contains a list of the items listed by the seller specified as input. The list of items is returned in an ItemArrayType object, in which are returned zero, one, or multiple ItemType objects. Each ItemType object contains the detail data for one item listing. Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries. GetSellerList Always none, ItemReturnDescription, ReturnAll If true, there are more items yet to be retrieved. Additional GetSellerList calls with higher page numbers or more items per page must be made to retrieve these items. Not returned if no items match the request. GetSellerList Conditionally none, ItemReturnDescription, ReturnAll Contains the list of the seller's items, one ItemType object per item. Returns empty if no items are available that match the request. GetSellerList Always none, ItemReturnDescription, ReturnAll Indicates the number of items that are being returned per page of data (i.e., per call). Will be the same as the value specified in the Pagination.EntriesPerPage input. Only returned if items are returned. GetSellerList Conditionally none, ItemReturnDescription, ReturnAll Indicates which page of data was just returned. Will be the same as the value specified in the Pagination.PageNumber input. (If the input is higher than the total number of pages, the call fails with an error.) Only returned if items are returned. GetSellerList Conditionally none, ItemReturnDescription, ReturnAll Indicates the total number of items returned (i.e., the number of ItemType objects in ItemArray). GetSellerList Always none, ItemReturnDescription, ReturnAll Indicates the seller whose items are returned. The seller is the eBay member whose UserID was passed in the request. If UserID was not specified, the seller is the user who made the request (identified by eBayAuthToken). GetSellerList Always none, ItemReturnDescription, ReturnAll Retrieves a summary of pending or paid payments that Half.com created for the seller identified by the authentication token in the request. Only retrieves payments that occurred within a particular pay period. Each payment is for one transaction for one item in one order. An order can contain transactions for multiple items from multiple sellers, but this call only retrieves payments that are relevant to one seller. The financial value of a payment is typically based on an amount that a buyer paid to Half.com for a transaction, with adjustments for shipping costs and Half.com's commission. For most sellers, each month contains two pay periods: One from the 1st to the 15th of the month, and one from the 16th to the last day of the month. Sellers can refer to their account information on the Half.com site to determine their pay periods. (You cannot retrieve a seller's pay periods by using eBay Web Services.) When a buyer makes a purchase and an order is created, Half.com creates a payment for the seller and marks it as Pending in the seller's Half.com account. Within a certain number of days after the pay period ends, Half.com settles payments for that period and marks each completed payment as Paid. See the Half.com Web site online help for more information about how payments are managed.

Retrieves a summary of pending or paid payments that Half.com created for the seller identified by the authentication token in the request.

Filter to retrieve only items with the specified payment status (Paid or Pending). "Pending payments" are payments that Half.com has created but that have not yet been sent to the seller's financial institution. Pending payments are typically available once a buyer pays for an order. As Half.com processes payments by using periodic batch jobs, the GetSellerPayments response might not include a transaction's payment for up to 20 minutes after the buyer has paid. You can retrieve pending payments for the current pay period. Pending payments that have not been settled yet can also be retrieved for previous pay periods. "Paid payments" are payments that Half.com processed during previous pay periods. Paid payments might not appear in the seller's financial institution account balance until a certain number of days after the current pay period ends (see the Half.com online help for details). You can only retrieve paid payments for one previous pay period at a time. GetSellerPayments Yes Time range filter that retrieves Half.com payments that were created within a single pay period. Sellers can refer to the Half.com site to determine their pay periods. PaymentTimeFrom is the earliest (oldest) time and PaymentTimeTo is the latest (most recent) time in the range. Half.com pay periods start and end at midnight Pacific time, but the time values are stored in the database in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and Pacific time. If you specify a PaymentStatus of Pending, add a buffer of one hour (or one day) to both ends of the time range to retrieve more data than you need, and then filter the results on the client side as needed. If any pending payments match the request, the response may include all payments since the beginning of the period. If you specify a PaymentStatus of Paid, the time range must contain one full pay period. That is, PaymentTimeFrom must be earlier or equal the start time of the pay period, and PaymentTimeTo must be later than or equal to the end time of the pay period. Otherwise, no paid payments are returned. For example, if the pay period starts on 2005-09-16 and ends on 2005-09-30, you could specify an earlier PaymentTimeFrom value of 2005-09-16T00:00:00.000Z and a later PaymentTimeTo value of 2005-10-01T12:00:00.000Z. If you specify a time range that covers two pay periods, only the payments from the most recent pay period are returned. The earliest time you can specify is 18 months ago. GetSellerPayments Yes Time range filter that retrieves Half.com payments for a single pay period. See the description of PaymentTimeTo for details about using this time range filter. For paid payments, this value should be equal to or later than the end of the last day of the pay period, where the time is converted to GMT. For example, if the period ends on 2005-09-30, you could specify 2005-10-01T09:00:00.000Z, which is later than the end of the last day. GetSellerPayments Yes If many payments are available, you may need to call GetSellerPayments multiple times to retrieve all the data. Each result set is returned as a page of entries. Use this Pagination information to indicate the maximum number of entries to retrieve per page (i.e., per call), the page number to retrieve, and other data. GetSellerPayments No Returns a summary of pending or paid payments that Half.com created for the seller identified by the authentication token in the request. Only returns payments that occurred within a particular pay period. Each payment is for one transaction for one item in one order. An order can contain transactions for multiple items from multiple sellers, but this call only retrieves payments that are relevant to one seller. Payments are only issued for items and transactions that the seller has confirmed (see the Half.com online help for details). The financial value of a payment is typically based on an amount that a buyer paid to Half.com for a transaction, plus the shipping cost the buyer paid to Half.com for the item, minus Half.com's commission. For most sellers, each month contains two pay periods: One from the 1st to the 15th of the month, and one from the 16th to the last day of the month. Payments are submitted to the seller's financial institution a certain number of days after the current pay period ends (see the Half.com online help for details). Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries. GetSellerPayments Always If true, there are more payments yet to be retrieved. Additional GetSellerPayments calls with higher page numbers or more entries per page must be made to retrieve these payments. If false, no more payments are available or no payments match the request (based on the payment status and time filter). GetSellerPayments Always Information about a single payment that matches the criteria in the request. A payment is between Half.com and a seller. Each payment is for one transaction for one item in one order. An order can contain transactions for multiple items from multiple sellers, but this call only retrieves payments that are relevant to one seller. The financial value of a payment is typically based on an amount that a buyer paid to Half.com for a transaction, plus the shipping cost the buyer paid for the item, minus Half.com's commission. Payments can also describe refunds that the seller has issued. Multiple SellerPayment entries can be returned per page of results. Typically, they are returned in reverse chronological order (most recent PaidTime first). Only returned if payments exist that match the request. GetSellerPayments Conditionally Indicates the number of payments that can be returned per page of data (i.e., per call). This is the same as the value specified in the Pagination.EntriesPerPage input (or the default value, if EntriesPerPage was not specified). This is not necessarily the actual number of payments returned per page (see ReturnedPaymentCountActual). GetSellerPayments Always Indicates which page of data holds the current result set. Will be the same as the value specified in the Pagination.PageNumber input. (If the input is higher than the total number of pages, the call fails with an error.) If no payments are returned, the value is 0. If payments are returned, the first page number is 1. GetSellerPayments Always Indicates the total number of payments returned (i.e., the number of SellerPayment entries returned. GetSellerPayments Always Retrieves a report containing information you can use to process the requesting seller's transactions. A transaction contains the information about the sale of one or more items by one buyer from a single listing. As some listings can return large numbers of transactions, use the supplied time filters to retrieve only those transactions whose status has been modified between two dates. Optionally, also configure the request to retrieve one page of data at a time (where each page contains a more manageable number of transactions). The user making the request can only retrieve their own transactions. That is, a user cannot retrieve all the transactions for another seller. If the user needs to retrieve transactions for another seller's listing, use GetItemTransactions instead. In general, only fields that are necessary for processing transactions are returned. For example, reserve price information would not be returned because the data is not relevant once the agreement to purchase the item has occurred. Also, fields that are not logically applicable are not returned. For example, TransactionArray.Transaction.Buyer.SellerInfo is not returned because the buyer is not acting in the role of a seller for the transaction. As the SellerType object is returned at the root level of the response, and as all transactions returned from this call are for the same seller, each individual Transaction.Item object does not return a SellerType object. Some fields that are defined on Transaction.Item (e.g., Item.SellingStatus.QuantitySold) sound similar to fields defined on Transaction (e.g., QuantityPurchased). The difference is that the item fields are applicable across the entire listing; whereas the transaction fields are only applicable for the particular transaction identified. For example, suppose a listing has 20 items and 10 of them have sold. This would cause the Transaction.Item.SellingStatus.QuantitySold value to be set to 10. If one transaction returned from GetSellerTransactionsCall represents one buyer's purchase of 3 of those items, the Transaction.QuantityPurchased value would be set 3 for that particular transaction. Notes: - In the TransactionArray.Transaction.ShippingDetails object, only one of FlatShippingRate or CalculatedRate will be returned, depending on which one the seller set. - In the Seller and Transaction.Item.Buyer objects, email and address data is only returned under certain conditions. - The TransactionArray.Transaction.Item.ListingDetails.RelistItemID object is only returned if the item was re-listed.

Retrieves data for transactions created by the sale of items that were listed by the user making the request. GetSellerTransactions returns zero, one, or multiple transactions (depending on the sale of items from the listing and the listing type). Input values allow the result set to contain just those transactions created between two specified dates. The return data contains information you can use to process transactions.

dl Email and Address Privacy Policy http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EmailPrivacyPolicy the conditions under which buyer and seller email and address are returned Describes the earliest (oldest) date to use in a date range filter based on the time a transaction's status was modified. Filters out transactions whose status was last modified before this date. The date range between ModTimeFrom to ModTimeTo cannot be greater than 30 days. GetSellerTransactions Yes Describes the latest (most recent) date to use in a date range filter based on the time a transaction's status was modified. Filters out transactions whose status was last modified after this date. The date range between ModTimeFrom to ModTimeTo cannot be greater than 30 days. It is considered a best practice to always pass the current date-time, to ensure that no data is missed. GetSellerTransactions Yes Child elements control pagination of the output. Use its EntriesPerPage property to control the number of transactions to return per call and its PageNumber property to specify the page of data to return. GetSellerTransactions No Indicates whether to include final value fees in the response. For most listing types, the fee is returned in Transaction.FinalValueFee. For Dutch auctions that end with bids (not Buy It Now purchases), the fee is returned in Item.SellingStatus.FinalValueFee. The Final Value Fee for FixedPriceItem, StoresFixedPrice, and Buy It Now Dutch listing types is returned on a transaction by transaction basis. For all other listing types, including Chinese and Dutch (no Buy It Now purchases), the Final Value Fee is returned when the listing status is Completed. GetSellerTransactions No For future use. GetSellerTransactions No Specifies a set of seller SKUs to use as a filter. Only items with the specified SKUs are returned. Do not specify this tag if you do not want to filter by SKU. Corresponds to the SKU property that is part of ItemType and that can be provided when, for example, you use the AddItem call. GetSellerTransactions No Returns an array of transaction data for the seller specified in the request. The results can be used to create a report of data that is commonly necessary for end-of-auction processing. Zero, one, or many Transaction objects can be returned in the array. The set of transactions returned is limited to those that were modified between the times specified in the request's ModTimeFrom and ModTimeTo filters. The transactions returned are sorted by Transaction.Status.LastTimeModified, ascending order (that is, transactions that more recently were modified are returned last). Also returns information about the seller whose transactions were requested. If pagination filters were specified in the request, returns meta-data describing the effects of those filters on the current response and the estimated effects if the same filters are used in subsequent calls. Contains the total number of pages (TotalNumberOfPages) and the total number of entries (TotalNumberOfEntries) that could be returned given repeated calls that use the same selection criteria as the call that returned this response. GetSellerTransactions Always none, ReturnAll, ItemReturnDescription Indicates whether there are additional transactions to retrieve. That is, indicates whether more pages of data are available to be returned, given the filters that were specified in the request. Returns false for the last page of data. GetSellerTransactions Always none, ReturnAll, ItemReturnDescription Number of transactions returned per page (per call). May be a higher value than ReturnedTransactionCountActual if the page returned is the last page and more than one page of data exists. GetSellerTransactions Always none, ReturnAll, ItemReturnDescription Page number for the page of transactions the response returned. GetSellerTransactions Always none, ReturnAll, ItemReturnDescription Number of transactions retrieved in the current page of results just returned. May be a lower value than TransactionsPerPage if the page returned is the last page and more than one page of data exists. GetSellerTransactions Always none, ReturnAll, ItemReturnDescription Contains information about the seller whose transactions are being returned. See the reference guide for information about the fields of the Seller object that are returned. GetSellerTransactions none, ReturnAll Always List of Transaction objects representing the seller's recent sales. Each Transaction object contains the data for one purchase (of one or more items in the same listing). See the reference guide for more information about the fields that are returned for each transaction. GetSellerTransactions none, ReturnAll Conditionally Indicates whether the seller has the preference enabled that shows that the seller prefers PayPal as the method of payment for an item. This preference is indicated on an item's View Item page and is intended to influence a buyer to use PayPal to pay for the item. GetSellerTransactions Always none, ReturnAll, ItemReturnDescription Requests data about a seller's eBay store. The caller must be the owner of an eBay store. The return value from GetStoreResponse is a StoreType, which contains the store's configuration, including the store name, URL, subscription level, and other data. You can set CategoryStructureOnly to True to retrieve information about the category hierarchy of the store only.

Requests data about a seller's eBay store.

If this is set to True, only the category structure of the store is returned. If this is not specified or set to False, the complete store configuration is returned. GetStore Conditionally Specifies the category ID for the topmost category to return (along with the subcategories under it, the value of the LevelLimit property determining how deep). This tag is optional. If RootCategoryID is not specified, then the category tree starting at that root Category is returned. GetStore Conditionally Specifies the limit for the number of levels of the category hierarchy to return, where the given root category is level 1 and its children are level 2. Only categories at or above the level specified are returned. This tag is optional. If LevelLimit is not set, the complete category hierarchy is returned. Stores support category hierarchies up to 3 levels only. GetStore Conditionally Returns the data describing a seller's eBay store, including name, description, URL, and other information. The caller making the request must be the owner of an eBay store. If the authenticated caller does not have an eBay store, the response is an error. A successful response contains either the complete store configuration or information about the category hierarchy for the store only. The data describing the store configuration. GetStore Always Returns the status of the processing progress for category structure changes specified with a SetStoreCategories request. Use this call to retrieve status when the SetStoreCategories call is being processed asynchronously. SetStoreCategories will be processed asynchronously when many listings are affected by the category structure changes.

Returns the status of the processing progress for category structure changes specified with a SetStoreCategories request.

The task ID returned by the SetStoreCategories call. If the SetStoreCategories call was processed asynchronously, the TaskID will be a positive number, otherwise the TaskID will be 0. GetStoreCategoryUpdateStatus Yes Returns the store category structure update status, when a prior SetStoreCategories call was processed asynchronously. If a SetStoreCategories request affects many listings, then the category structure changes will be processed asynchronously. If not many listings are affected by category structure changes, the status is returned in the SetStoreCategories response. The status (Pending, InProgress, Complete, or Failed) of an update to the store category structure. GetStoreCategoryUpdateStatus Always Retrieves the custom page or pages for the user's Store.

Retrieves the custom page or pages for the user's Store.

If a PageID is specified, then that page is returned, and the returned page contains the page Content. If no PageID is specified, then all pages are returned, without the page Content. GetStoreCustomPage No Contains the custom page or pages for the user's Store. The custom page or custom pages. GetStoreCustomPage Always Retrieves the current list of Store configuration options.

Retrieves the current list of Store configuration options.

Contains the current list of options for Store configurations. The current set of basic themes. Each basic theme definition specifies a valid color scheme for the theme. GetStoreOptions Always The current set of advances themes. Unlike basic themes, you can use any color scheme with an advanced theme. These themes are suitable for more advanced customization. GetStoreOptions Always The current set of Store logos. These logos are used in the Store header. GetStoreOptions Always The current set of eBay Store subscription tiers and corresponding subscription prices. GetStoreOptions Always The maximum number of categories in this store. GetStoreOptions Always The maximum number of category levels in this store. GetStoreOptions Always Retrieves a user's Store preferences.

Retrieves a user's Store preferences.

Contains the Store preferences retrieved for a user. The user's Store preferences. GetStorePreferences Always Requests a list of up to 10 categories with the highest percentage of listings whose titles or descriptions contain the keywords you specify.

Requests a list of up to 10 categories with the highest percentage of listings whose titles or descriptions contain the keywords you specify.

Specifies the search string, consisting of one or more words to search for in the listing title. The words "and" and "or" are treated like any other word. 350 (characters) GetSuggestedCategories Yes Returns a list of categories with the highest number of listings whose titles or descriptions contain the keywords specified in a GetSuggestedCategoriesRequest. Contains the categories that contain listings that match the query string in the request. The array can have up to 10 categories. Not returned if no categories match the query in the request. GetSuggestedCategories Conditionally Indicates the number of categories in the array. GetSuggestedCategories Always Retrieves the tax table for a user on a given site or retrieves the valid jurisdictions (if any) for a given site.

Retrieves the tax table for a user on a given site or retrieves the valid jurisdictions (if any) for a given site.

dl Response to GetTaxTableRequest. The last time (in GMT) that the tax table was updated. Only returned if the user previously created a tax table and if the site has jurisdictions. LastUpdateTime is useful for synchronization. If you cache the user's tax table, you can use GetTaxTable to check if it has changed and whether you need to update the cached tax table. GetTaxTable Conditionally ReturnAll, none A container of tax jurisdiction information unique to a user/site combination. Empty if not set for user. If DetailLevel is not specified, information is only returned for the jurisdictions for which the user provided tax information. If DetailLevel is ReturnAll, tax information is returned for all possible jurisdictions, whether specified by the user or not. ShippingIncludedInTax and SalesTaxPercent are returned but are empty. GetTaxTable Always ReturnAll, none Retrieves information about a user. Inputs controls what user data is returned. This includes the eBay user ID for the user whose data is to be returned and the item ID for a listing to indicate a transactional relationship between the requestor and the target user.

Retrieves data for one eBay user. Input is the eBay user ID for the user about whom to return data.

Specifies the item ID for a successfully concluded listing in which the requestor and target user were participants (one as seller and the other as buyer). Necessary to return certain data (like an email address). Not necessary of the requestor is retrieving own data. ItemID is an optional input. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetUser No Specifies the user whose data will returned by the call. UserID is optional. If not specified, the user data returned is that for the requesting user. GetUser No Contains the data retrieved by the call. User data is returned in a User object. Contains the returned user data for the specified eBay user. GetUser none, ReturnAll Always Returns contact information for a specified user if a bidding relationship exists between them. That is, the bidder must be bidding on the seller's active item, or an eBay user must have made an offer on the item via Best Offer. The item must be in the Motors or Business & Industrial categories. Note that GetUserContactDetails does NOT return an email address.

Returns contact information for a specified user. Sellers can retrieve contact information for both bidders and users who have made offers (via Best Offer) during an active listing. Buyers can also use this call to contact sellers of an item they are bidding on or have made an offer on (via Best Offer). Note that this call does not return an email address. Sellers who wish to send an email message to their bidders should use AddMemberMessagesAAQToBidder instead.

An eBay ID that uniquely identifies a given item. Must be a currently active item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetUserContactDetails Yes An eBay ID that uniquely identifies a given user. The same as the contact's eBay username. Either the seller's or bidder's username may be specified here, as long as a bidding relationship exists between them. That is, the bidder must be bidding on the seller's active item, or an eBay user must have made an offer on the item via Best Offer. GetUserContactDetails Yes An eBay ID that uniquely identifies a given user. The same as the seller's eBay username. Either the seller's or bidder's username may be specified here, as long as a bidding relationship exists between them. That is, the bidder must be bidding on the seller's active item, or an eBay user must have made an offer on the item via Best Offer. GetUserContactDetails Yes Returns contact information to a seller for both bidders and users who have made offers (via Best Offer) during an active listing. An eBay ID that uniquely identifies a given user. The eBay username of the requested contact. GetUserContactDetails Always Contact information for the requested contact. Note that the email address is NOT returned. GetUserContactDetails Always The date and time that the requested contact registered with eBay. GetUserContactDetails Always Requests a list of disputes the requester is involved in as buyer or seller. The list includes both Unpaid Item and Item Not Received disputes and can be filtered according to DisputeFilterType. Use a DetailLevel of ReturnAll to return all data about each dispute, including DisputeResolution and DisputeMessage elements.

Requests a list of disputes the requester is involved in as buyer or seller.

dl A filter that specifies a subset of disputes to return. The return list includes both Item Not Received and Unpaid Item disputes. GetUserDisputes No The value and sequence to use to sort the returned disputes. GetUserDisputes No A filter that retrieves disputes whose DisputeModifiedTime is later than or equal to this value. Specify the time value in GMT. See the eBay Web Services documentation for information about specifying time values. For more precise control of the date range filter, it is a good practice to also specify ModTimeTo. Otherwise, the end of the date range is the present time. Filtering by date range is optional. You can use date range filters in combination with other filters like DisputeFilterType to control the amount of data returned. GetUserDisputes No A filter that retrieves disputes whose DisputeModifiedTime is earlier than or equal to this value. Specify the time value in GMT. See the eBay Web Services documentation for information about specifying time values. For more precise control of the date range filter, it is a good practice to also specify ModTimeFrom. Otherwise, all available disputes modified prior to the ModTimeTo value are returned. Filtering by date range is optional. You can use date range filters in combination with other filters like DisputeFilterType to control the amount of data returned. GetUserDisputes No The virtual page number of the result set to display. A result set has a number of disputes divided into virtual pages, with 200 disputes per page. The response can only display one page. The first page in the result set is number 1. Required. If not specified, a warning is returned and Pagination.PageNumber is set to 1 by default. GetUserDisputes Yes Returns a list of disputes that involve the calling user as buyer or seller, in response to a GetUserDisputesRequest. The index of the first dispute in the current result set, relative to the total number of disputes available. Primarily useful for interpreting paginated results. For example, if 228 disputes are available and 200 results are returned per page: The first page returns a StartingDisputeID value of 1 and the second page returns a StartingDisputeID value of 201. GetUserDisputes Always ReturnSummary, ReturnAll, none The index of the last dispute in the current result set, relative to the total number of disputes available. Primarily useful for interpreting paginated results. For example, if 228 disputes are available and 200 results are returned per page: The first page returns an EndingDisputeID value of 200 and the second page returns an EndingDisputeID value of 228. GetUserDisputes Always ReturnSummary, ReturnAll, none The array of disputes returned. GetUserDisputes Always ReturnSummary, ReturnAll, none The number of disputes on each virtual page in the result set. The virtual page returned is determined by PageNumber. Default is 200. GetUserDisputes Always ReturnSummary, ReturnAll, none The page of the total result set returned in the call. The entire result set is virtual and the call returns only one page of it. GetUserDisputes Always ReturnSummary, ReturnAll, none The number of disputes that involve the requester as buyer or seller and match a given filter type. GetUserDisputes Always ReturnSummary, ReturnAll, none The result of the pagination, including the total number of virtual pages in the result set and the total number of disputes returned. GetUserDisputes Always ReturnSummary, ReturnAll, none Retrieves some or all of a user's preferences. The set of preferences retrieved depends on the set of flags specified in the request.

Retrieves some or all of a user's preferences.

If true, requests a seller's preferences for receiving bidder notices. GetUserPreferences No If true, requests a seller's preferences for accepting payments that combine item purchases into one order. GetUserPreferences No If true, requests a seller's cross-promotion preferences, such as whether cross-promotions are enabled and the sort filters used. GetUserPreferences No If true, displays a seller's payment preferences, for displaying a Pay Now button, accepting PayPal, and so on. GetUserPreferences No If true, displays the seller's end of auction email preferences. GetUserPreferences No If true, retrieves preferences the seller has set for displaying items on a buyer's favorite sellers page and in the favorite sellers email digest. GetUserPreferences No If true, displays the seller's preference regarding whether they want their eligible listings to be included on eBay Express. As of release 463, this flag is no longer recommended. Instead, the ExpressPreferences node will always be returned if the user is eligible for Express, and it will never be returned if the user is not eligible. That is, there is no "Show" filter to retrieve the ExpressPreferences node. Express preferences are dependent on the user's site of registration, not the site to which you send the request. GetUserPreferences No Obsolete If true, returns ProStores checkout preferences. false GetUserPreferences No Returns some or all of a user's preferences. The preferences are grouped in sets, according to the sets requested. Contains a seller's preferences for receiving bidder notices. Returned when the request sets ShowBidderNoticePreferences to true. GetUserPreferences Conditionally Contains a seller's preferences for accepting combined payments. Returned when ShowCombinedPaymentPreferences is true. GetUserPreferences Conditionally Contains a seller's cross-promotion preferences. Returned when ShowCrossPromotionPreferences is true. GetUserPreferences Conditionally Contains a seller's preferences for accepting payments. Returned when ShowSellerPaymentPreferences is true. GetUserPreferences Conditionally Contains a seller's preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest. GetUserPreferences Conditionally Contains the user's end of auction email preferences. GetUserPreferences Conditionally Contains a seller's eBay Express preference regarding whether they want their eligible listings to be included on eBay Express. Returned when the request sets ShoweBxOptInPreference to true. As of release 463, applications should start using ExpressPreferences instead. GetUserPreferences Conditionally Deprecated The seller's Express preferences. Always returned for sellers who are eligible to list on Express. Not returned for sellers who are not eligible per eBay's requirements. If ExpressPreferences is not returned, call GetUser and check the value of SellerInfo.ExpressEligible. If the seller is not eligible, see "eBay Express" in the eBay Web Services guide for possible reasons. Note that if the seller opts out of Express themselves (but would otherwise be eligible), ExpressPreferences is returned. In this case, GetUser may show that the user is not eligible to list on Express. Express preferences are returned based on the seller's registration site, not the site to which you send the request. For example, a US seller's preferences will be returned even if you submit the request to site 77 (Germany). GetUserPreferences Conditionally Details about ProStores and checkout preferences. GetUserPreferences Conditionally Requests data for a specific, active Want It Now post identified by a post ID.

Requests data for a specific, active Want It Now post identified by a post ID.

Specifies the post ID that uniquely identifies the Want It Now post for which to retrieve the data. PostID is a required input. PostID is unique across all eBay sites. GetWantItNowPost Yes Contains the Want It Now post data returned by the call. The data for the specified post listing is returned in a WantItNowPostType object. Contains the data defining a single Want It Now post. GetWantItNowPost Always Retrieves a list of active Want It Now posts that match specified keywords and/or other search criteria.

Retrieves a list of active Want It Now posts that match specified keywords and/or other search criteria.

Limits the result set to just those Want It Now posts listed in the specified category. Defaults to all categories if no category ID is specified. If the specified category ID does not match an existing category for the site, an invalid-category error message is returned. Controls the set of listings to return (not the details to return for each listing). You must specify a Query and/or a CategoryID in the request. 10 GetWantItNowSearchResults No Specifies a search string. The search string consists of one or more keywords to search for in the listing title. Note that the post description will also be searched if SearchInDescription is enabled. By default, requests return a list of Want It Now posts that include all of the keywords specified in the Query. All words used in the query, including "and," "or," and "the," will be treated as keywords. You can, however, use modifiers and wildcards (e.g., +, -, and *) in the Query field to create more complex searches. Be careful when using spaces before or after modifiers and wildcards (+, -, or *), as the spaces can affect the query logic. See the eBay Web Services Guide for a list of valid search keyword query operators and examples. 350 (characters) GetWantItNowSearchResults No If true, include the description field of Want It Now posts in the keyword search. Want It Now posts returned are those where specified search keywords appear in either the description or the title. This is the default behavior if SearchInDescription is not specified. If false, only the title will be searched. SearchInDescription is an optional input. GetWantItNowSearchResults No If true, the search applies to all eBay sites. If false, the search is limited to the site specified in the URL query string when the call is made. GetWantItNowSearchResults No Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and which page of data to return. GetWantItNowSearchResults No Response contains the Want It Now posts that have the specified keyword(s) in the title and (optionally) the description. Response contains the Want It Now posts that have the specified keyword(s) in the title and (optionally) the description. Contains the returned Want It Now posts, if any. The data for each post is returned in a WantItNowPostType object. GetWantItNowSearchResults Always Indicates whether there are additional Want It Now posts that meet the search criteria. GetWantItNowSearchResults Always Indicates the maximum number of Want It Now posts that can be returned in a WantItNowPostArray for a request. This value can be specified in the request by EntriesPerPage in Pagination in the request. GetWantItNowSearchResults Always Indicates the page of data returned by the current call. GetWantItNowSearchResults Always Indicates the results of the pagination, including the total number of pages of data there are to be returned and the total number of posts there are to be returned. GetWantItNowSearchResults Always Retrieves eBay IDs and codes (e.g., site IDs and shipping service codes), enumerated data (e.g., payment methods), and other common eBay meta-data. This call enables you to keep certain data up to date in your applications without referring to the schema, the documentation, or the eBay online help. Other data is returned for your reference, but you may need to refer to the schema or the documentation for information about valid values and usage. In some cases, the data returned in the response will vary according to the site that you use for the request.

Retrieves eBay IDs and codes (e.g., site IDs and shipping service codes), enumerated data (e.g., payment methods), and other common eBay meta-data.

A designation of what kind of information you wish returned for the specified eBay site. If omitted, all details are returned. The possible values for input (the enumeration values of DetailNameCodeType) are the same name as fields returned by the response. See the documentation for the GeteBayDetails response to better understand the DetailName options. GeteBayDetails No Details about a specified site in response to GeteBayDetailsRequest. If no DetailName is identified in the request, all elements of GeteBayDetailsResponse are returned. Otherwise, only the element corresponding to the specified DetailName is returned. Details about a specified site in response to GeteBayDetailsRequest. If no DetailName is identified in the request, all elements of GeteBayDetailsResponse are returned. Otherwise, only the element corresponding to the specified DetailName is returned. Details about a specific country. GeteBayDetails returns all countries in the system, regardless of the site to which you sent the request. GeteBayDetails Conditionally Details about a specific currency that can be used for listing on an eBay site. GeteBayDetails returns all site currencies in the system, regardless of the site to which you sent the request. GeteBayDetails Conditionally Details about a specific max dispatch time. A dispatch time specifies the maximum number of business days a seller commits to for shipping an item to domestic buyers after receiving a cleared payment. GeteBayDetails returns all dispatch times in the system, regardless of the site to which you sent the request. GeteBayDetails Conditionally Details about a specific buyer payment method. GeteBayDetails only returns payment methods that are applicable to the site to which you sent the request. GeteBayDetails Conditionally Details about a specific geographical region. GeteBayDetails only returns regions that are applicable to the site to which you sent the request. However, you should ignore region values for all sites except China. GeteBayDetails Conditionally Details about a location or region to which the seller is willing to ship. GeteBayDetails returns all shipping locations in the system, regardless of the site to which you sent the request. GeteBayDetails Conditionally Details about a specific shipping service. GeteBayDetails only returns shipping services that are applicable to the site to which you sent the request. GeteBayDetails Conditionally Details about a specific eBay site. GeteBayDetails returns all sites in the system, regardless of the site to which you sent the request. GeteBayDetails Conditionally Details about a specific tax jurisdiction or tax region. GeteBayDetails only returns jurisdictions that are applicable to the site to which you sent the request. Related fields: TaxTable.TaxJurisdiction in SetTaxTable Item.UseTaxTable in Additem GeteBayDetails Conditionally Details about a specific eBay URL. GeteBayDetails only returns URLs that are applicable to the site to which you sent the request. GeteBayDetails Conditionally Gets the official eBay system time in GMT.

Gets the official eBay system time in GMT.

The Timestamp field indicates the official eBay system time in GMT. For information about converting between GMT and other time zones, see "Time Values" in the Data Types appendix in the eBay Web Services guide. Issues a refund for a single Half.com transaction. Can only be called by a seller. Refunds may only be issued for a specific transaction. Sellers do not have the ability to issue a general refund (not tied to a transaction) to a buyer.

Issues a refund for a single Half.com transaction.

ID of the Half.com item associated with the refund payment to the buyer. To uniquely identify a transaction, you need to specify both ItemID and TransactionID. Use GetSellerPayments to determine the item ID and transaction ID associated with the original sale payment. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) IssueRefund Yes ID of the Half.com transaction associated with the refund payment. To uniquely identify a transaction, you need to specify both ItemID and TransactionID. Use GetSellerPayments to determine the item ID and transaction ID associated with the original sale payment. 10 IssueRefund Yes Explanation of the reason that the refund is being issued. IssueRefund Yes Explanation of the costs that the refund amount covers. IssueRefund Yes The amount the seller wants to refund to the buyer, in US Dollars (USD). Must be greater than 0.00. Half.com allows a maximum of the original item sale price (transaction price plus original shipping reimbursement) plus return shipping costs (the amount the buyer paid to return the item). Typically, the return shipping cost is based on the current cost of shipping the individual item (not the discounted cost calculated during the original checkout for a multi-item order). You can also issue a partial refund for the amount you want the buyer to receive. If RefundType=Full or RefundType=FullPlusShipping and you do not pass RefundAmount in the request, Half.com will calculate the refund amount for you. If you pass RefundAmount in the request, the amount you specify will override Half.com's calculated value. Required if RefundType= CustomOrPartial. IssueRefund Conditionally Note to the buyer. Cannot include HTML. 400 IssueRefund No Indicates the refund amount that a seller issued to a buyer for a single Half.com transaction. Refunds may only be issued for a specific transaction. Sellers do not have the ability to issue a general refund (not tied to a transaction) to a buyer. Total amount that the seller asked Half.com to refund to a buyer for a Half.com transaction. IssueRefund Always Total amount that Half.com refunded to the buyer (which could include the refund amount from the seller plus a refund amount from Half.com). IssueRefund Always Enables a user to leave feedback about another user. Both users (the sender and the recipient) must have a transactional relationship. That is, they must have both been participants in a successfully concluded item sale transaction that took place no more than 90 days prior. Also, the sending user cannot have already left feedback for the recipient for the transaction.

Enables a user to leave feedback about another user.

Item ID for the listing from which the transaction relating the users (the feedback sender and recipient). Transaction must not have been created more than 90 days prior to the attempt to leave feedback. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) LeaveFeedback Yes Textual comment that explains, clarifies, or justifies the feedback score specified in CommentType. LeaveFeedback Yes Score for the feedback being left. May be Positive, Neutral, or Negative. LeaveFeedback Yes The item purchase transaction from the listing specified in ItemID for which the feedback is being left. Required if the listing identified in ItemID was a multi-item listing (Dutch auction or multi-item fixed-price listing). 10 LeaveFeedback Conditionally Specifies the recipient user about whom the feedback is being left. LeaveFeedback Yes LeaveFeedback response message includes an acknowledgement if the feedback was successfully left. (out) The ID of the feedback that has been left. LeaveFeedback Always Enables the requesting user to submit a bid (make an offer) on the item listing specified in ItemID. For competitive-bidding listings (Chinese and Dutch auctions), makes a bid. For fixed-price listings (Basic Fixed-Price and eBay Stores Inventory listings), purchases the item.

Enables the requesting user to submit a bid (make an offer) on the item listing specified in ItemID.

Specifies the type of offer being made. If the item is a competitive-bidding listing, the offer is a bid. If the item is a fixed-price listing, then the offer purchases the item. If the item is a competitive-bidding listing and the offer is of type with an active, unexercised Buy It Now option, then the offer can either purchase the item or be a bid. See the schema documentation for OfferType for deatils on its properties and their meanings. PlaceOffer Yes Unique item ID that identifies the item listing for which the offer is being submitted. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) PlaceOffer Yes (in) If a warning message exists and BlockOnWarning is true, the warning message is returned and the bid is blocked. If no warning message exists and BlockOnWarning is true, the bid is placed. If BlockOnWarning is false, the bid is placed, regardless of warning. PlaceOffer No The PlaceOffer result set provides feedback on the success and result of the offer made. Indicates the current bidding/purchase state of the item listing, as of the offer extended using PlaceOffer. See the schema documentation for the SellingStatus object, the properties of which contain such post-offer information as the current high bidder, the current price for the item, and the bid increment. PlaceOffer Always Enables a seller to take a single item (or a single multi-item listing) that ended without bidders or buyers and re-list it on a specified eBay site. The listing may be re-listed with the same item properties as the original or the seller may change a number of the item's defining properties at re-listing time. The new listing will have a different item ID than the original one. RelistItem re-lists a single item (or a single multi-item listing) that has already ended. To re-list multiple items (multiple listings) that have ended, execute RelistItem once for each ended listing.

Enables a seller to take a single item (or a single multi-item listing) that ended without bidders or buyers and re-list it on a specified eBay site.

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 In release 439 and later, ModifiedFields is no longer required to change field values, but it is still supported for backward compatibility. It is strongly recommended that you do not use ModifiedFields in this call. See the eBay Web Services Guide for information about the DeletedField tag and for rules and guidelines for changing values when relisting items. ModifiedFields contains an array of item property changes. Each element in the array indicates a first level property in the Item object (specified in the Item property) that is changing in the re-list. Item properties not specified in ModifiedFields are not changed in the item re-list, even if a new value is specified in the property in the Item object. Properties not specified retain the same value as is present in the ended item listing being re-listed. RelistItem Conditionally Deprecated 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: Item.AttributeSetArray Item.Charity Item.DigitalDeliveryDetails Item.ListingDesigner.LayoutID Item.ListingDesigner.ThemeID Item.ListingEnhancement[Value] Item.PayPalEmailAddress Item.PictureDetails.GalleryURL Item.PictureDetails.PictureURL Item.ProductListingDetails Item.ProximitySearchDetails.PostalCode Item.SecondaryCategory Item.ShippingDetails.PaymentInstructions Item.SKU Item.SubTitle 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. To delete a listing enhancement like Featured, specify the value you are deleting; for example, Item.ListingEnhancement[Featured]. RelistItem Conditionally Returns the item ID and the estimated fees for the re-listed listing. 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 Provides users the ability to remove items from their My eBay watch list.

Provides users the ability to remove items from their My eBay watch list.

The ID of the item to be removed from the watch list. Either ItemID or RemoveAllItems must be specified, but NOT both. One or more Item IDs can be specified, each in it's own ItemID container. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) RemoveFromWatchList Conditionally If true, then all the items in the user's watch list are removed. Either ItemID or RemoveAllItems must be specified, but NOT both. RemoveFromWatchList Conditionally Returns information about the user's My eBay watch list. (out) The current number of items in the user's watch list (after those specified in the call request have been removed) AddToWatchList Always (out) The maximum number of items allowed in watch lists. Currently this value is the same for all sites and all users. AddToWatchList Always Enables the seller of a Best Offer item to respond with Accept or Decline to offers made by bidders.

Enables the seller of a Best Offer item to respond with Accept or Decline to offers made by bidders.

Specifies the item for which the BestOffer data is to be returned. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) RespondToBestOffer Yes The ID of a Best Offer for the item. RespondToBestOffer Yes The action taken on the best offer by the seller (e.g., Accept, Decline, or Counter). Bulk Accept and Bulk Counter are not supported. That is, you cannot accept or counter multiple offers in a single call. You can, however, decline multiple offers in a single call. RespondToBestOffer Yes A comment from the seller to the buyer. 250 RespondToBestOffer Conditionally The counter offer price. When Action is set to Counter, you must specify the amount for the counteroffer with CounterOfferPrice. The value of CounterOfferPrice cannot exceed the Buy It Now price for a single quantity item. The value of CounterOfferPrice may exceed the Buy It Now price if the value for CounterOfferQuantity is greater than 1. RespondToBestOffer Conditionally The counter offer quantity. When Action is set to Counter you must specify the quantity of items for the counteroffer with CounterOfferQuantity. RespondToBestOffer Conditionally Contains a list of BestOffers that were either accepted or declined. A list of BestOffers that were either accepted or declined. RespondToBestOffer Always Enables users to reply to feedback left by the other party in the transaction and/or follow up on the feedback left for the other party.

Enables users to reply to feedback left by the other party in the transaction and/or follow up on the feedback left for the other party.

ID that uniquely identifies the feedback. FeedbackIDs can be retrieved by using GetFeedback. Required if ItemID is not specified. RespondToFeedback Conditionally Unique identifier of an item to which the feedback is attached. Required if FeedbackID is not provided. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) RespondToFeedback Conditionally Unique identifier for a purchase from an eBay Stores Inventory or basic fixed price listing. If TransactionID is specified, ItemID must also be specified. 10 RespondToFeedback No User who left the feedback that is being replied to or followed up on. RespondToFeedback Yes Specifies whether the response is a reply or a follow-up. RespondToFeedback Yes Textual comment that the user who is subject of feedback may leave in response or rebuttal to the feedback. Alternatively, when the ResponseType is FollowUp, this value contains the text of the follow-up comment. Max length is 125 for the Taiwan site. 80 RespondToFeedback Yes Indicates the success or failure of the attempt to reply to feedback that has been left for a user, or to post a follow-up comment to a feedback comment a user has left for someone else. Enables a seller to respond to a Want It Now post with an item listed on the eBay site.

Enables a seller to respond to a Want It Now post with an item listed on the eBay site.

The unique identifier of an item listed on the eBay site. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) RespondToWantItNowPost Yes The unique identifier of a Want It Now post on the eBay site. RespondToWantItNowPost Yes Indicates the success or failure of the attempt to respond to a Want It Now post. Enables a seller to update the payment status of an item.

Enables a seller to update the payment status of an item.

Third Party Checkout http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ThirdPartyCheckout Checkout http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Checkout Unique ID for the item associated with the checkout. A transaction is uniquely identified by one of two means: (a) You provide a TransactionID and ItemID. (This is the preferred approach.), OR, (b) You provide a BuyerID and ItemID and eBay identifies only one transaction for that combination (an error is returned if there are multiple transactions for that combination). Note: If all three are provided (that is, BuyerID, ItemID and TransactionID), BuyerID is ignored. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) ReviseCheckoutStatus Yes Unique ID for the transaction associated with the checkout. For Chinese auctions, the value passed in the TransactionID argument must be 0 or the call will fail with an error. For all other auction types, TransactionID accepts the actual, nonzero transaction ID. Call GetItemTransactionsCall or GetSellerTransactionsCall to determine the correct transaction ID. A transaction is uniquely identified by one of two means: (a) You provide a TransactionID and ItemID. (This is the preferred approach.), OR, (b) You provide a BuyerID and ItemID and eBay identifies only one transaction for that combination (an error is returned if there are multiple transactions for that combination). Note: If all three are provided (that is, BuyerID, ItemID and TransactionID), BuyerID is ignored. 10 ReviseCheckoutStatus Conditionally Unique ID for a multi-item order. If specified, ItemID and TransactionID are ignored if specified in the same call. Changes to the checkout status are applied to the specified order as a whole (and thus the child transactions associated with the order). ReviseCheckoutStatus No The amount paid by the buyer. For an eBay Stores item, the value passed in AmountPaid is the transaction/item price. For a US eBay Motors item, AmountPaid is the total amount paid by the buyer for the deposit. ReviseCheckoutStatus No Payment method used by the buyer. Required if CheckoutStatus is Complete. ReviseCheckoutStatus Conditionally The current status of the checkout process for the transaction. ReviseCheckoutStatus Yes The shipping service selected by the buyer from among the shipping services offered by the seller (such as UPS Ground). For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. ReviseCheckoutStatus No An indicator of whether shipping costs were included in the taxable amount. For Third-Party Checkout applications. ReviseCheckoutStatus No false Not supported. ReviseCheckoutStatus No The insurance option selected by the buyer. ReviseCheckoutStatus No Not supported. ReviseCheckoutStatus No Discount or charge agreed to by the buyer and seller. A positive value indicates that the amount is an extra charge being paid to the seller by the buyer. A negative value indicates that the amount is a discount given to the buyer by the seller. ReviseCheckoutStatus No For internal use. ReviseCheckoutStatus No eBay ID for the buyer in the transaction being revised. A transaction is uniquely identified by one of two means: (a) You provide a TransactionID and ItemID. (This is the preferred approach.), OR, (b) You provide a BuyerID and ItemID and eBay identifies only one transaction for that combination (an error is returned if there are multiple transactions for that combination). Note: If all three are provided (that is, BuyerID, ItemID and TransactionID), BuyerID is ignored. ReviseCheckoutStatus Conditionally Amount of money paid for insurance. For Third Party Checkout applications. ReviseCheckoutStatus No Amount of money paid for sales tax. For Third-Party Checkout applications. ReviseCheckoutStatus No Amount of money paid for shipping. For Third-party Checkout applications. ReviseCheckoutStatus No Not supported. 20 ReviseCheckoutStatus No Not supported. ReviseCheckoutStatus No Not supported. ReviseCheckoutStatus No Indicates success or failure of the attempt to revise the listing's checkout status. Enables a seller to make changes to the definition of an active item listing.

Enables a seller to change the properties of a currently active listing. Inputs are the item ID of the ended item being re-listed and any properties that are being changed for the revision.

Required. 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. Also applicable to Half.com. ReviseItem Yes In release 439 and later, ModifiedFields is no longer required to change field values, but it is still supported for backward compatibility. It is strongly recommended that you do not use ModifiedFields in this call. See the eBay Web Services Guide for information about the DeletedField tag and for rules and guidelines for changing values when revising items. ModifiedFields contains an array of item property changes. Each element in the array indicates a first level property in the Item object (specified in the Item property) that is changing in the revision. Item properties not specified in ModifiedFields are not changed in the item revision - even if a new value is specified in the property in the Item object. Properties not specified retain the same value as is present in the active item listing being revised. To remove a property from the item, specify it as changed in ModifiedFields, but do not specify a value in Item. Also applicable to Half.com. ReviseItem Conditionally Deprecated Specifies the name of a field to delete from a listing. You cannot delete required fields from a listing. Some fields are optional when you first list an item (e.g., ListingEnhancement), 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. For example, if GalleryType was already set for the item you are revising, you cannot remove it. Therefore, you still need to include at least one picture URL, a gallery URL, or a catalog stock photo in your revised listing. 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). 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: Item.AttributeSetArray Item.DigitalDeliveryDetails Item.ListingDesigner.LayoutID Item.ListingDesigner.ThemeID Item.PayPalEmailAddress Item.PictureDetails.GalleryURL Item.PictureDetails.PictureURL Item.PostalCode Item.ProductListingDetails Item.ProximitySearchDetails.PostalCode Item.ShippingDetails.PaymentInstructions Item.SKU 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. ReviseItem Conditionally Returns the item ID and the estimated fees for the revised listing. 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 new listing. Also returned for Half.com (for Half.com, the start time is always the time the item was 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 Enables a seller to make changes to the definition of an active item listing that listed for the Live Auction.

Enables an eBay Live Auctions seller to modify a single lot item on the eBay Live Auctions site.

Required. Child elements hold the values for properties that are changing. The Item.ID 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. To remove a property, do not give it a value in Item, but specify it as changed in ModifiedFields. Each first-level property that has a changed value must be listed in the ModifiedFields property. ReviseLiveAuctionItem Yes Array of item property changes. Each element in the array indicates a first level property in the Item object (specified in the Item property) that is changing in the revision. Item properties not specified in ModifiedFields are not changed in the item revision - even if a new value is specified in the property in the Item object. Properties not specified retain the same value as is present in the active item listing being revised. To remove a property from the item, specify it as changed in ModifiedFields, but do not specify a value in Item. ReviseLiveAuctionItem Conditionally Reserved for future use. ReviseLiveAuctionItem No Returns the item ID and the estimated fees for the revised listing. 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) ReviseLiveAuctionItem 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. ReviseLiveAuctionItem 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 ReviseLiveAuctionItem 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 ReviseLiveAuctionItem Conditionally Sets the read state for messages and alerts, the flagged state of messages, and moves alerts and messages into and out of folders.

Sets the read state for messages and alerts, the flagged state of messages, and moves alerts and messages into and out of folders.

Contains a list of up to 10 MessageID values. Either AlertIDs, MessageIDs, or both must be included in the request. ReviseMyMessages Conditionally Contains a list of up to 10 AlertID values. Either AlertIDs, MessageIDs, or both must be included in the request ReviseMyMessages Conditionally Changes the read states of all alerts and messages specified in a request by their AlertID or MessageID values. At least one of Read, Flagged, or FolderID must be specified in the request. Note that alerts and messages retrieved with the API are not automatically marked Read, and must be marked Read with this call. ReviseMyMessages Conditionally Changes the flagged states of all messages specified in a request by their MessageID values. At least one of Read, Flagged, or FolderID must be specified in the request. ReviseMyMessages Conditionally An ID that uniquely identifies the My Messages folder to move alerts and messages into. At least one of Read, Flagged, or FolderID must be specified in the request. ReviseMyMessages Conditionally The response to ReviseMyMessagesRequestType. If the request was successful, ReviseMyMessages returns nothing. Renames, removes, or restores specified My Messages folders for a given user.

Renames, removes, or restores specified My Messages folders for a given user.

Indicates the type of operation to perform on a specified My Messages folder. Operations include renaming, removing, and restoring folders. Operations cannot be performed on the Inbox and Sent folders. ReviseMyMessagesFolders Yes An ID that uniquely identifies the My Messages folder to perform the operation on. Retrieve FolderIDs by calling GetMyMessages with a DetailLevel of ReturnSummary. Inbox is FolderID = 0, and Sent is FolderID = 1. ReviseMyMessagesFolders Yes The name of a specified My Messages folder. Depending on the specified Operation, the value is an existing folder name or a new folder name. Retrieve existing FolderNames by calling GetMyMessages with a DetailLevel of ReturnSummary. Inbox is FolderID = 0, and Sent is FolderID = 1. ReviseMyMessagesFolders Conditionally The response to ReviseMyMessagesFoldersRequestType. If the request was successful, ReviseMyMessagesFolders returns nothing. Enables a seller to reverse an Unpaid Item dispute that has been closed, for example, if buyer and seller reach an agreement. The seller's Final Value Fee credit and the buyer's strike are both reversed.

Enables a seller to reverse an Unpaid Item dispute that has been closed, for example, if buyer and seller reach an agreement.

The unique identifier of the dispute that was returned when the dispute was created. The dispute must be an Unpaid Item dispute that the seller opened. Required. SellerReverseDispute Yes The reason the dispute is being reversed. Required. SellerReverseDispute Yes Returned after calling SellerReverseDisputeRequest. Contains the status of the call and any errors or warnings. Enables a seller to send an invoice to buyer for a transaction.

Enables a seller to send an invoice to a buyer for a transaction.

Item ID. If OrderID is not provided, both ItemID and TransactionID must be provided. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) SendInvoice Conditionally ID for the transaction with which the item was sold. If OrderID is not provided, both ItemID and TransactionID must be provided. For Chinese auctions, the value passed in the TransactionId argument must be 0 or the call will fail with an error. Call GetItemTransactions or GetSellerTransactions to determine the correct transaction ID. 10 SendInvoice Conditionally Unique ID for a multi-item order. Either this OrderID must be specified or ItemID plus TransactionID must be specified. If OrderID is specified, ItemID and TransactionID are ignored if present in the same request. Changes to the checkout status are applied to the specified order as a whole (and thus to the child transactions associated with the order). SendInvoice Conditionally Shipping costs and options related to an international shipping service. When used as input, if one is provided, at least one domestic ShippingService must be provided. Not applicable to invoices for digital listings. SendInvoice No Indicates the shipping service that would be used to ship the item (such as UPS Ground). Seller can provide up to three. Shipping insurance cost should be identical for all domestic services. Not applicable to invoices for digital listings. SendInvoice No The details of the sales tax added to the invoice. SendInvoice No Specifies whether insurance fee is required. An InsuranceOption value of IncludedInShippingHandling cannot be used if the item will use calculated shipping. Some shipping carriers automatically include shipping insurance for qualifying items. Not applicable to invoices for digital listings. SendInvoice No Getting Shipping Cost Information http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts Insurance cost, as set by seller, if ShippingType = 1. Specify if InsuranceOption is optional or required. Must be greater than zero value if a value of Optional or Required is passed in InsuranceOption. Value specified should be the total cost of insuring the item. Not applicable to invoices for digital listings. 0.0 SendInvoice No Getting Shipping Cost Information http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts Optional ability for the seller to add certain payment methods on transaction if they were not originally specified on the item. Valid values are PayPal in the US, MoneyXferAcceptedInCheckout (CIP+) in Germany, and Escrow in China SendInvoice No Provide PayPal email address if the payment method added is PayPal. For digital listings, this must be an email address associated with a verified PayPal Premier or Business account. SendInvoice No Seller's Payment instructions/message to the buyer and return policy. Default is null. 500 SendInvoice No Specifies whether the seller wishes to be copied on the invoice email that will be sent to the buyer. Default will be true. SendInvoice No Returns the status. Manages a user's notification preferences. These preferences can be at the application level, or at the user level.

Manages a user's notification preferences. Part of eBay Platform Notifications, which can be used to alert Production-certified applications when certain events occur on the eBay site.

Specifies application-based event preferences that have been enabled. SetNotificationPreferences No Array of NotificationEventEnableTypes. Each NotificationEventEnableType contains an EventSetting and an EventType. SetNotificationPreferences No Specifies user data for notification settings such as mobile phone number. SetNotificationPreferences No Characteristics or details of an event such as type, name and value. Currently can only be set for wireless applications. SetNotificationPreferences No (out) Returned after a call to SetNotificationPreferences to indicate that the call succeeded. Creates, updates, or deletes Picture Manager account settings, folders, or pictures.

Creates, updates, or deletes Picture Manager account settings, folders, or pictures.

Specifies the setting or folder to create, update, or delete, or the picture to update. You cannot upload or delete pictures using SetPictureManagerDetails; you must use the eBay site. SetPictureManagerDetails Yes Specifies the action to take on the setting, folder, or picture. The values Add and Delete apply only to folders. SetPictureManagerDetails Yes Returns the status of an action on a setting, folder, or picture in a Picture Manager account. Requests to define cross-promotion rules for an item or store category.

Requests to define cross-promotion rules for an item or store category.

Specifies whether the update is for item rules or default rules for the promotion type. Allowed values are ItemRules or ReplaceAllDefaultRules. Required when setting default rules. SetPromotionRules Conditionally Specifies a list of cross-promotion rules to set. Each rule defines a referring item or store category and the cross-promoted items or store categories. SetPromotionRules Yes Returned after calling SetPromotionRulesRequest to indicate whether the rules have been set successfully. Configures your application's Auth n Auth preferences and other data, such as the URLs that eBay should redirect users to after they complete the authentication and authorization process. This call must be authenticated using the application's username and password (not an authentication token).

Configures your application's authentication and authorization preferences and other data, such as the URLs that eBay should redirect users to after they complete the authentication and authorization process.

Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth The authentication preferences and other data that you are adding, deleting, or modifying. SetReturnURL Yes Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Sets an application display name for the eBay sign-in page. Need not be set with every call. Optional. SetReturnURL No Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Specifies whether the authentication entry is being added, deleted, or modified. SetReturnURL Yes Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Confirms whether your application's authentication preferences and other details were configured successfully. Contains the Store configuration that is being set by this call.

Contains the Store configuration that is being set by this call.

Specifies the Store configuration that is being set for the user. SetStore Yes Returned after calling SetStoreRequest. This serves as confirmation that the Store configuration was successfully submitted. Requests changes to the category structure for a store. Use this call to add, delete, move, or rename a list of categories.

Requests changes to the category structure for a store.

Specifies the type of action (Add, Move, Delete, or Rename) to carry out for the specified categories. SetStoreCategories Yes Items can only be contained within child categories. A parent category cannot contain items. If adding, moving, or deleting categories displaces items, you must specify a destination child category under which the displaced items will be moved. The destination category must have no child categories. SetStoreCategories Conditionally When adding or moving store categories, specifies the category under which the listed categories will be located. To add or move categories to the top level, set the value to -999. SetStoreCategories Conditionally Contains information for specifying the store categories being acted on. SetStoreCategories Yes Returns the status of the processing progress for changes to the category structure for a store. The task ID associated with the category structure change request. If the SetStoreCategories call is process synchronously, the task ID is 0. If the category structure changes affect many listings, the changes will be processed asynchronously and the task ID will be a positive number. Use the task ID with GetStoreCategoryUpdateStatus to monitor the status of asynchronously processed changes. SetStoreCategories Always When a category structure change is processed synchronously, the status is returned as Complete or Failed. For asynchronously processed changes, the status is reported as Pending. Use GetStoreCategoryUpdateStatus to monitor the status of asynchronously processed changes. SetStoreCategories Always Sets a Store custom page.

Sets a custom page for a user's eBay Store. The page can include static HTML content as well as dynamic content that is added using the special eBay Stores tags.

The custom page being submitted. SetStoreCustomPage Yes Returned after calling SetStoreCustomPageRequest. This serves as confirmation that the custom page was successfully submitted. The custom page that was submitted. SetStoreCustomPage Always Contains the Store configuration that is being set by this call.

Sets the preferences for a user's eBay Store. These preferences include various seller vacation options.

Specifies the store preferences. SetStorePreferences No Returned after calling SetStorePreferencesRequest. This serves as confirmation that the Store preferences were successfully submitted. Sets the tax table for a seller on a given site.

Sets the tax table for a seller on a given site.

A container of tax jurisdiction information unique to a user/site combination. SetTaxTable Yes Response to SetTaxTableRequest. Enables users to add, modify and delete Notes from the items that are being tracked in the My eBay All Selling and All Buying areas.

Enables users to add, modify and delete Notes from the items that are being tracked in the My eBay All Selling and All Buying areas.

ID of the item to which the note will be attached. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) SetUserNotes Yes Specifies whether to add/update the note or delete. SetUserNotes Yes Text of the note. Maximum 250 characters. Required only if the Action is AddOrUpdate. 250 SetUserNotes Conditionally Returns the status of the call. Sets the user's preferences to those specified in the request. As a general rule, once you set a preference, GetUserPreferences and the user's preferences displayed on the eBay Web site should reflect the new setting immediately. However, it could take up to 7 days for the change to have any logical or functional effect. For example, if you change your combined payment preferences, it could take up to 7 days for eBay to apply the updated combined payment settings to your listings. Also, once you set a preference, you cannot change its setting again within 7 days.

Sets the user's preferences to those specified in the request.

The user's bidder notice preferences to be set. SetUserPreferences No The user's combined payment preferences to be set. When you change these preferences, it can take up to 7 days for the change to have any logical or functional effect on eBay. For the US and Germany sites, combined payment preferences can also affect whether a seller is eligible to list on Express. A seller needs to allow shoppers to pay by single, combined payments for their purchases. A seller is not eligible for Express if they don't allow combined payments. Once changes to these preferences take effect on eBay (within 7 days), it can take up to 7 more days for existing items to be added to or removed from Express. Thus, it can take up to 14 days (total) for combined payment preference changes to affect whether listings appear on Express. Also see ExpressPreferences.ExpressSellingPreferences. SetUserPreferences No The user's cross promotion preferences to be set. SetUserPreferences No The user's seller payment preferences to be set. SetUserPreferences No Seller's favorite item preferences to be set. SetUserPreferences No The seller's end of auction email preferences to be set. SetUserPreferences No TThe seller's Express opt-in preference, which indicates whether they want their eligible listings to be included on eBay Express. As of release 463, you should use ExpressPreferences instead. Only applicable to sellers who are eligible to list on Express. Call GetUser to determine the seller's eligibility. This flag may be obsolete soon. SetUserPreferences No ObsoleteSoon The seller's Express preferences. Currently used to indicate which of the seller's eligible listings to include on Express. You can only set these preferences for sellers who are eligible to list on Express. To determine the seller's eligibility, call GetUser and check the value of SellerInfo.ExpressEligible. Once you set Express preferences, you cannot set them again (e.g., to change the value) within 7 days. Also see CombinedPaymentPreferences, which affect a seller's eligibility to list on Express. SetUserPreferences No Returned after a call to SetUserPreferences to indicate that the call succeeded. Requests to enable a test user to sell items in the Sandbox environment.

Requests to enable a test user to sell items in the Sandbox environment.

Value for the feedback score of a user. If no value is passed in the request, or if the value is zero, the feedback score is unchanged. This element is not intended for regularly testing feedback because the feedback value can change after the request. ValidateTestUserRegistration No Value for the date and time that a user's registration begins. ValidateTestUserRegistration No Indicates if a user subscribes to Seller's Assistant. You cannot request to subscribe a user to both Seller's Assistant and Seller's Assistant Pro. You cannot request to unsubscribe a user. ValidateTestUserRegistration No Indicates if a user subscribes to Seller's Assistant Pro. You cannot request to subscribe a user to both Seller's Assistant and Seller's Assistant Pro. You cannot request to unsubscribe a user. ValidateTestUserRegistration No Indicates if a user subscribes to Selling Manager. You cannot request to subscribe a user to both Selling Manager and Selling Manager Pro. You cannot request to unsubscribe a user. ValidateTestUserRegistration No Indicates if a user subscribes to Selling Manager Pro. You cannot request to subscribe a user to both Selling Manager and Selling Manager Pro. You cannot request to unsubscribe a user. ValidateTestUserRegistration No Returned after calling ValidateTestUserRegistrationRequest; confirms a successful call. Defines a single new item and tests the definition for validity. Behaves exactly the same as AddItem (same inputs, same outputs, and same behavior and usage rules), but without actually listing the item to an eBay site. Applications can use this call to test the definition of an item before actually listing it to eBay with AddItem, reducing item listing-related errors.

Enables a seller to specify the properties for a new item and submit to eBay without creating a listing. This enables the seller to test the specified item properties for validity and get an estimate of the listing fees before actually listing the item. Inputs are the same as for AddItem.

ItemType object, the properties of which define the new item listing. VerifyAddItem Yes Deprecated. 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. 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. 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. VerifyAddItem Conditionally Returns the estimated fees that would be applicable for a new listing (were the item actually listed to eBay with AddItem). 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. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) VerifyAddItem 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. VerifyAddItem Always 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 Emulates the creation of a new Second Chance Offer listing for an item to one of that item's non-winning bidders.

Tests the input for AddSecondChanceItem, without actually creating the second chance offer listing. Used for testing the listing of an item that will be made for one of the item's non-winning bidders.

Specifies the bidder from the original, ended listing to whom the seller is extending the second chance offer. Specify only one RecipientBidderUserID per call. If multiple users are specified (each in a RecipientBidderUserID node), only the last one specified receives the offer. VerifyAddSecondChanceItem Yes Specifies the amount the offer recipient must pay to purchase the item from the second chance offer listing. Use only when the original item was an eBay Motors (or in some categories on U.S. and international sites for high-priced items, such as items in many U.S. and Canada Business and Industrial categories) and it ended unsold because the reserve price was not met. Call fails with an error for any other item conditions. VerifyAddSecondChanceItem No Specifies whether to send a copy to the seller of the second chance offer notification email that goes to the recipient user. With 457, the seller always receives a copy of the email, and this tag is ignored as input. VerifyAddSecondChanceItem No Obsolete Specifies the length of time the second chance offer listing will be active. The recipient bidder has that much time to purchase the item or the listing expires. VerifyAddSecondChanceItem No Specifies the item ID for the original, ended listing from which the second chance offer item comes. A new ItemID is returned for the second chance offer item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) VerifyAddSecondChanceItem Yes Reserved for internal or future use. No Message content. Cannot contain HTML, asterisks, or quotes. This content is included in the second chance offer email sent to the recipient, which can be retrieved with GetMyMessages. 1000 VerifyAddSecondChanceItem No VerifyAddSecondChanceItem request to emulate creation of a new Second Chance Offer for an item to one of that item's bidders. Contains the listing fees for the new second chance offer listing. No fees are actually assessed as VerifyAddSecondChanceItem does not actually create the new second chance offer listing. Provides an estimate of the fees should the offer actually be made using AddSecondChanceItem. See the documentation on Value-Added Tax. Value-Added Tax (VAT) http://developer.ebay.com/DevZone/XML/docs/WebHelp/B2BandVAT-Value-Added_Tax_(VAT).html VerifyAddSecondChanceItem Always Indicates the date and time when the the new second chance offer listing became active and the recipient user could purchase the item. VerifyAddSecondChanceItem Always Indicates the date and time when the second chance offer listing expires, at which time the listing ends (if the recipient user does not purchase the item first). VerifyAddSecondChanceItem Always 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. 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.) Note that DetailLevel is required input for GetMyMessages. 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. GetAttributesCS GetAttributesXSL GetCategories GetCategory2CS GetCategory2FinanceOffer GetCategoryFeatures GetCategoryMappings GetFeedback GetFinanceOffers GetItemTransactions GetItem GetMyeBayBuying GetMyeBaySelling GetMyMessages GetOrders GetOrderTransactions GetProductFinder GetProductFinderXSL GetProductSearchPage GetSearchResults GetSellerEvents GetSellerList GetSellerTransactions GetTaxTable GetUser GetUserDisputes 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). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_TW Taiwan zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong No http://www.ietf.org/rfc/rfc3066.txt Tags for the Identification of Languages In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID 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. If you do not pass MessageID in the request, CorrelationID is not returned. Note that some calls are designed to retrieve large sets of meta-data that only change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). In these cases, the correlation ID is not applicable. However, if you specify an input filter to reduce the amount data returned, you can use MessageID and CorrelationID for these meta-data calls. These are the meta-data calls that can return cached responses: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXsl, GetProductFinder, GetProductFinderXsl, and GetProductSearchPage. No The version of the request payload schema. If you are using the SOAP API, this field is required in the body of the request. Specify the version of the schema your application is using. 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. (eBay only uses the value in this HTTP header when processing XML API requests. 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.) The version you specify for a call has two effects: - It directly indicates the version of the code lists and other data that eBay should use to process your request. - It indirectly indicates the API compatibility level of the data and functionality you are using. See the eBay Web Services guide for information about schema versions, code lists, and compatibility levels. Conditionally Error tolerance level for the call. For calls that support Item Specifics, this is a preference that controls how eBay handles listing requests when invalid attribute data is passed in. See Attribute Error Handling in the eBay Web Services guide for details about this field in listing requests. AddItem AddLiveAuctionItem CompleteSale RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem 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 AddItem AddLiveAuctionItem AddMemberMessage AddOrder AddSecondChanceItem AddToItemDescription PlaceOffer RelistItem ReviseCheckoutStatus ReviseItem ReviseLiveAuctionItem No Controls whether or not to return warnings when the application passes unrecognized elements in a request (i.e., elements that are not defined in the schema). (This does not control warnings related to unrecognized values within elements.) Schema element names are case-sensitive, so this option can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in tag names before you put your application into the Production environment. Note that this setting only validates elements; it does not validate XML attributes. 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 Base type definition of a response payload that can carry any type of payload content with following optional elements: - timestamp of response message - application-level acknowledgement - 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. Certain calls, such as GetCategories, can return very large responses that change once a day or less often. For better performance, such calls may return cached data. In these cases, this time value reflects the time the cached response was created. Thus, this value is not necessarily within a few seconds of the time you submitted the request. These are the meta-data calls that can return cached responses: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXsl, GetProductFinder, GetProductFinderXsl, and GetProductSearchPage. 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. Always In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID 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. If you do not pass MessageID in the request, CorrelationID is not returned. Note that some calls are designed to retrieve large sets of meta-data that only change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). In these cases, the correlation ID is not applicable. However, if you specify an input filter to reduce the amount data returned, you can use MessageID and CorrelationID for these meta-data calls. These are the calls that can return cached responses: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXsl, GetProductFinder, GetProductFinderXsl, and GetProductSearchPage. Conditionally A list of application-level errors (if any) that occurred when eBay processed the request. Conditionally Supplemental information from eBay, if applicable. May elaborate on errors or provide useful hints for the seller. This data can accompany the call's normal data result set or a result set that contains only errors. 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. Because this data is returned as a string, the HTML markup elements are escaped with character entity references (e.g.,<table><tr>...). See the appendices in the eBay Web Services guide for general information about string data types. AddItem AddLiveAuctionItem AddToItemDescription EndItem PlaceOffer RelistItem RespondToWantItNowPost ReviseItem ReviseLiveAuctionItem VerifyAddItem Conditionally 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. 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. Always Event name of the notification. Only returned by Platform Notifications. Information that explains a failure due to a duplicate InvocationID being passed in. AddItem AddLiveAuctionItem AddMemberMessage AddOrder AddSecondChanceItem AddToItemDescription PlaceOffer RelistItem ReviseCheckoutStatus ReviseItem ReviseLiveAuctionItem 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, GetReturnURL, GetRuName, SetReturnURL Conditionally AckCodeType - Type declaration to be used by other schema. 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. CompleteSale GetPopularKeywords Conditionally (out) Reserved for internal or future use. 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. (in/out) No payment method specified. For example, no payment methods would be specified for Ad format listings. ReviseCheckoutStatus Conditionally (in/out) Money order/cashiers check. AddItem RelistItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) American Express. AddItem RelistItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) Payment instructions are contained in the item's description. AddItem RelistItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) Credit card. Not applicable to Real Estate or US/CA eBay Motors listings. AddItem RelistItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) Personal check. AddItem RelistItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) 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. AddItem RelistItem VerifyAddItem ReviseCheckoutStatus No Deprecated GetItem Conditionally Deprecated (in/out) Visa/Mastercard. AddItem RelistItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) PaisaPay (for India site only). AddItem RelistItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) Other forms of payment. Some custom methods are accepted by seller as the payment method in the transaction. AddItem RelistItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) PayPal is accepted as a payment method. If true for a listing, Item.PayPalEmailAddress must also be set for the listing. 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 and return a warning. 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.) For additional information about PayPal, see the eBay Web Services Guide. AddItem RelistItem VerifyAddItem Conditionally GetItem Conditionally (in/out) Discover card. AddItem RelistItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) Payment on delivery. Not applicable to Real Estate or US/CA eBay Motors listings. AddItem RelistItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) Direct transfer of money. AddItem RelistItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) 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. AddItem RelistItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) All other online payments. AddItem VerifyAddItem Conditionally GetItem Conditionally (in/out) China site payment method: Escrow managed payment. If a seller on the eBay China site has a feedback score less than 5 OR a positive feedback rate less than 90% OR the seller is unverified (CN verified status), then escrow is required for the seller to list an item. If escrow is required and an attempt is made to list an item without offering escrow, then an error message is returned. For additional information, see the International Differences Overview in the eBay Web Services Guide. AddItem AddLiveAuctionItem RelistItem ReviseItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) China site payment method: PrePayDelivery. NOTE: This value is deprecated. AddItem VerifyAddItem ReviseCheckoutStatus Conditionally Deprecated GetItem Conditionally Deprecated (in/out) Cash On Delivery After Paid. Applicable for eBay China site only (site ID 223). AddItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (in/out) China site payment method: PostalTransfer. AddItem VerifyAddItem ReviseCheckoutStatus Conditionally GetItem Conditionally (out) Reserved for internal or future use. (in/out) 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). AddItem VerifyAddItem Conditionally GetItem Conditionally (in/out) Cash-in-person option. Applicable only to US and Canada eBay Motors vehicles, (not the Parts and Accessories category). AddItem VerifyAddItem Conditionally GetItem Conditionally 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, GetReturnURL, GetRuName, SetReturnURL Yes Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth 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, GetReturnURL, GetRuName, SetReturnURL 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 GetReturnURL GetRuName SetReturnURL 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. DetailLevelCodeType - Type declaration to be used by other schema. 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) Returns Item Specifics and Pre-filled Item Information, if applicable (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. GetMyMessages "Retrieving FolderID and FolderName Values" http://developer.ebay.com/DevZone/XML/docs/WebHelp/GetMyMessagesCall-GetMyMessages_Samples.html GetMyMessages No (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: - All alerts in priority order with the highest priority alerts first - 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. GetMyMessages No (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. GetMyMessages No Defines the action taken on a dispute with AddDisputeResponse. The value you can use at a given time depends on the current value of DisputeState (see the Developer Guide for more information). Some values are for Unpaid Item disputes and some are for Item Not Received disputes. (in) The seller wants to add a response to the dispute. For Unpaid Item disputes. (in) The buyer has paid or the seller otherwise does not need to pursue the dispute any longer. For Unpaid Item disputes. (in) The seller has made an agreement with the buyer and requires a credit for a Final Value Fee already paid. For Unpaid Item disputes. (in) The seller wants to end communication or stop waiting for the buyer. For Unpaid Item disputes. (in) The seller wants to end communication or stop waiting for the buyer. Mutual agreement has been reached or the buyer has not responded within 7 days. For Unpaid Item disputes. (in) The seller offers a full refund if the buyer did not receive the item or a partial refund if the item is significantly not as described. For Item Not Received or Significantly Not As Described disputes. Can be used when DisputeState is: NotReceivedNoSellerResponse NotAsDescribedNoSellerResponse NotReceivedMutualCommunication NotAsDescribedMutualCommunication (in) The seller has shipped the item or a replacement and provides shipping information. For Item Not Received and Significantly Not As Described disputes. Can be used when DisputeState is: NotReceivedNoSellerResponse NotReceivedMutualCommunication (in) The seller communicates with the buyer, offering a response or comment. For Item Not Received and Significantly Not As Described disputes. Can be used when DisputeState is: NotReceivedNoSellerResponse NotAsDescribedNoSellerResponse NotReceivedMutualCommunication NotAsDescribedMutualCommunication (in) Seller hasn't received payment or the payment hasn't cleared yet. For Item Not Received disputes. Can be used when DisputeState is: NotReceivedNoSellerResponse NotReceivedMutualCommunication (out) Reserved for internal or future use. Indicates whether the dispute is currently eligible for Final Value Fee credit. The value does not indicate whether the credit will actually be made. Applies to Unpaid Item disputes. (out) The seller is not currently eligible for a credit. (out) The seller is eligible for a credit. (out) Reserved for internal or future use. Contains the dispute explanation, entered when the dispute was created. Provides additional information to supplement the dispute reason. The values allowed depend on the value of DisputeReason. (in/out) The buyer has not responded within the 7-day waiting period. Allowed when DisputeReason is BuyerHasNotPaid. (in/out) The buyer has refused to pay. Allowed when DisputeReason is BuyerHasNotPaid. (in/out) The buyer is not cleared to pay. Allowed when DisputeReason is BuyerHasNotPaid. (in/out) The buyer returned the item for a refund. Allowed when DisputeReason is TransactionMutuallyCanceled. (in/out) The buyer and seller were unable to resolve a disagreement over terms. Allowed when DisputeReason is TransactionMutuallyCanceled. (in/out) The buyer no longer wants the item. Allowed when DisputeReason is TransactionMutuallyCanceled. (in/out) The buyer made a mistake. Allowed when DisputeReason is TransactionMutuallyCanceled. (in/out) The buyer requests shipment to a country that the seller does not ship to. Allowed when DisputeReason is BuyerHasNotPaid. AddDispute Conditionally Deprecated (in/out) The buyer requests shipment to an unconfirmed address. Allowed when DisputeReason is BuyerHasNotPaid or TransactionMutuallyCanceled. (in/out) The buyer requests a payment method that the seller does not accept. Allowed when DisputeReason is BuyerHasNotPaid or TransactionMutuallyCanceled. AddDispute Conditionally Deprecated (in/out) The buyer is no longer a registered user. Allowed when DisputeReason is BuyerHasNotPaid. (in/out) Some other reason not specified in this code list. Allowed when DisputeReason is BuyerHasNotPaid or TransactionMutuallyCanceled. (in/out) Used when DisputeReason is ItemNotReceived or SignificantlyNotAsDescribed. (out) Reserved for internal or future use. The number of disputes that match a given filter. A filter used to reduce the number of disputes returned. The filter uses criteria such as whether the dispute is awaiting a response, is closed, or is eligible for credit. Both Unpaid Item and Item Not Received disputes can be returned for the same filter value. GetUserDisputes Always ReturnSummary, ReturnAll, none The number of disputes that match the filter. In the GetUserDisputes response, not returned for the filter type that was used in the request. GetUserDisputes Always ReturnSummary, ReturnAll, none Specifies which disputes are returned. Filtering is done for disputes that are awaiting a certain party's response or are closed. The returned list can contain both Unpaid Item and Item Not Received disputes. All disputes returned involve the requester as buyer or seller. (in) All disputes that involve me as buyer or seller. (in) All disputes that involve me as buyer or seller and are awaiting my response. Default value. (in) All disputes that involve me as buyer or seller and are awaiting the other party's response. (in) All disputes that involve me as buyer or seller and are closed. (in) All disputes that involve me as buyer or seller and are eligible for a Final Value Fee credit, whether or not the credit has been granted. (in) All Unpaid item disputes. GetUserDisputes No (in) All Item Not Received disputes. GetUserDisputes No (out) Reserved for internal or future use. An identifier of a dispute. Defines who added a message to a dispute. Used for both Unpaid Item and Item Not Received disputes. (out) The buyer of the item under dispute. (out) The seller of the item under dispute. (out) eBay, either an administrator or the site itself. (out) Reserved for internal or future use. Contains a message posted to a dispute. The message can be posted by the buyer, the seller, or an eBay representative. (out) An ID that uniquely identifies the message. GetDispute Always GetUserDisputes Conditionally ReturnAll, none The party who posted the message: the buyer, the seller, or an eBay representative. GetDispute Always GetUserDisputes Conditionally ReturnAll, none The date and time the message was created, in GMT. GetDispute Always GetUserDisputes Conditionally ReturnAll, none The text of the message. GetDispute Always GetUserDisputes Conditionally ReturnAll, none Specifies the top-level reason for the dispute and determines the values you can use for DisputeExplanation. Some values are for Item Not Received disputes and others are for Unpaid Item Process disputes. (in/out) The buyer has not paid for the item. For Unpaid Item Process disputes. (in/out) The buyer and seller have agreed not to complete the transaction. For Unpaid Item Process disputes. (out) The buyer did not receive the item. An output value for Item Not Received disputes. (out) The item was significantly not as described in the listing. An output value for Item Not Received disputes. (out) Reserved for internal or future use. Describes the type of dispute, either Unpaid Item or Item Not Received. (out) An Unpaid Item dispute. (out) An Item Not Received dispute. (out) Reserved for internal or future use. Defines the reason a dispute was resolved. (out) The dispute was not resolved. (out) The buyer provided proof of payment in feedback. (out) The buyer or seller had a technical problem with a computer. (out) The buyer and seller have not made contact. (out) The buyer or seller had a family emergency. (out) The buyer provided proof of payment in feedback. (out) The dispute was the buyer's first infraction. (out) The buyer and seller came to agreement. (out) The buyer returned the item. (out) The buyer reimbursed the seller's auction fees. (out) The seller received payment. (out) Some other resolution occurred. (out) Reserved for internal or future use. Specifies the action taken by eBay as a result of the dispute resolution. (out) The buyer received an Unpaid Item Strike. (out) The buyer is suspended and unable to use the eBay site. (out) The seller received a Final Value Fee credit. (out) The seller's listing fee was credited. (out) The buyer's unpaid item strike was appealed. (out)The buyer's suspension was reversed. (out) The seller's Final Value Fee credit was reversed. (out) The seller's listing fee was reversed. (out) The buyer is given a ticket. (out) The seller did not receive a Final Value Fee credit. (out) Reserved for internal or future use. Contains all information about a dispute resolution. A dispute can have a resolution even if the seller does not receive payment. The resolution can have various results, including a Final Value Fee credit to the seller or a strike to the buyer. The action resulting from the resolution, affecting either the buyer or the seller. GetUserDisputes Conditionally ReturnAll, none The reason for the resolution. The DisputeResolutionReason results in the action described by the DisputeResolutionRecordType. GetUserDisputes Conditionally ReturnAll, none The date and time the dispute was resolved, in GMT. GetUserDisputes Conditionally ReturnAll, none Specifies how a list of returned disputes should be sorted. (in) Sort by the time the dispute was created, in descending order. (in) Sort by the time the dispute was created, in ascending order. (in) Sort by the time the dispute was created, in descending order. (in) Sort by the dispute status, in ascending order. (in) Sort by the dispute status, in descending order. (in) Sort by whether the dispute is eligible for Final Value Fee credit, in ascending order. Ineligible disputes are listed before eligible disputes. (in) Sort by whether the dispute is eleigible for Final Value Fee credit, in descending order. Eligible disputes are listed before i(ineligible disputes. (out) Reserved for internal or future use. Defines the current state of the dispute, which determines the values that are valid for DisputeActivity. DisputeState is an internal value returned in the response. A value can apply to an Unpaid Item or Item Not Received dispute. A dispute filed when an item is significantly not as described in the product listing is a variation of an Item Not Received dispute. (out) The dispute is locked and cannot be updated. For any type of dispute. No values of DisputeActivity are vald. (out) The dispute is closed. In some cases, it can be reversed with SellerReverseDispute. For any type of dispute. No values of DisputeActivity are valid. (out) eBay sent the buyer an Unpaid Item Reminder with a Pay Now option. Waiting for the buyer's first response. It is within the 7- day grace period. For Unpaid Item disputes. DisputeActivity can be SellerAddInformation or SellerCompletedTransaction. (out) eBay sent the buyer an Unpaid Item Reminder with no Pay Now option. Waiting for the buyer's first response. It is within the 7- day grace period. For Unpaid Item disputes. DisputeActivity can be SellerAddInformation or SellerCompletedTransaction. (out) eBay sent the buyer an Unpaid Item Reminder with a Pay Now option. Waiting for the buyer's first response. The 7-day grace period has expired. For Unpaid Item disputes. DisputeActivity can be SellerAddInformation, SellerCompletedTransaction, or SellerEndCommunication. (out) eBay sent the buyer an Unpaid Item Reminder with no Pay Now option. Waiting for the buyer's first response. The 7-day grace period has expired. For Unpaid Item disputes. DisputeActivity can be SellerAddInformation, SellerCompletedTransaction, or SellerEndCommunication. (out) The buyer and seller have communicated, and the buyer was offered a Pay Now option. For Unpaid Item disputes. DisputeActivity can be SellerAddInformation, SellerCompletedTransaction, SellerEndCommunication, or CameToAgreementNeedFVFCredit. (out) The buyer and seller have communicated. The buyer does not have a Pay Now option. For Unpaid Item disputes. DisputeActivity can be SellerAddInformation, SellerCompletedTransaction, SellerEndCommunication, or CameToAgreementNeedFVFCredit. (out) The dispute is pending resolution. For Unpaid Item disputes. No values of DisputeActivity are valid. (out) The buyer and seller have agreed within the grace period not to complete the transaction. For Unpaid Item disputes. DisputeActivity can be SellerAddInformation. (out) The buyer and seller have agreed not to complete the transaction, after the grace period. For Unpaid Item disputes. DisputeActivity can be SellerAddInformation, SellerCompletedTransaction, or SellerEndCommunication. (out) The buyer filed an Item Not Received dispute, and the seller has not responded. For Item Not Received disputes. DisputeActivity can be SellerOffersRefund, SellerShippedItem, or SellerComment. (out) The buyer filed an Item Not Received dispute for an item significantly not as described, and the seller has not responded. DisputeActivity can be SellerOffersRefund or SellerComment. (out) The buyer filed an Item Not Received dispute and is communicating with the seller. DisputeActivity can be SellerOffersRefund, SellerShippedItem, or SellerComment. (out) The buyer filed an Item Not Received dispute for an item significantly not as described and is communicating with the seller. DisputeActivity can be SellerOffersRefund. (out) The seller says mutual agreement has been reached and is waiting for the buyer to confirm, or the buyer is returning the item to the seller. DisputeActivity can be SellerAddInformation. (out) Reserved for internal or future use. Describes the status of the dispute, which supplements the DisputeState. Some values apply to Unpaid Item disputes and some to Item Not Received disputes. Disputes can be sorted by DisputeStatus. Ascending order is: 1 - WaitingForSellerResponse 2 - WaitingForBuyerResponse 3 - ClosedFVFCreditStrike 4 - ClosedNoFVFCreditStrike 5 - ClosedFVFCreditNoStrike 6 - ClosedNoFVFCreditNoStrike 7 - Closed 8 - StrikeAppealedAfterClosing 9 - FVFCreditReversedAfterClosing 10 - StrikeAppealedAndFVFCreditReversed Descending order is the reverse. (out) The dispute is closed. For Item Not Received disputes. (out) The dispute is waiting for the seller's response. For both Unpaid Item and Item Not Received disputes. (out) The dispute is waiting for the buyer's response. For both Unpaid Item and Item Not Received disputes. (out) The dispute is closed, the seller received a Final Value Fee credit, and the buyer received a strike. For Unpaid Item disputes. (out) The dispute is closed, the seller did not receive a Final Value Fee credit, and the buyer received a strike. For Unpaid Item disputes. (out) The dispute is closed, the seller received a Final Value Fee credit, and the buyer did not receive a strike. For Unpaid Item disputes. (out) The dispute is closed, the seller did not receive a Final Value Fee credit, and the buyer did not receive a strike. For Unpaid Item disputes. (out) The buyer's strike was appealed after the dispute was closed. For Unpaid Item disputes. (out) The seller's Final Value Fee credit was reversed after the dispute was closed. For Unpaid Item disputes. (out) Both the seller's Final Value Fee credit and the buyer's strike were reversed after the dispute was closed. For Unpaid Item disputes. (out) Reserved for internal or future use. Contains properties that provide information on duplicate uses of InvocationIDs. The duplicate InvocationID. AddItem AddLiveAuctionItem AddMemberMessage AddOrder AddSecondChanceItem AddToItemDescription PlaceOffer RelistItem ReviseLiveAuctionItem ReviseCheckoutStatus ReviseItem Conditionally The status of the previous call that used the InvocationID. AddItem AddLiveAuctionItem AddMemberMessage 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 AddLiveAuctionItem AddMemberMessage 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. Conditionally 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. Conditionally (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 developer guide for details about these preferences, their effects, and defaults for applicable calls, (in) Apply validation rules that were in effect prior to the time the call started supporting ErrorHandling. As of March 2005, only applicable to listing requests that include Item Specifics. AddItem AddLiveAuctionItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No (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. See the developer guide for applicable calls and features. For the AddItem family of calls, this value is used as the default error handling preference (if no preference is specified). AddItem AddLiveAuctionItem CompleteSale RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No (in) As of March 2005, only applicable to listing requests that include Item Specifics. 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. AddItem AddLiveAuctionItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No (in) If any data is invalid, reject the request. See the developer guide for information about applicable calls and features. For CompleteSale, this value is used as the default error handling preference (if BestEffort is not specified). AddItem AddLiveAuctionItem CompleteSale RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No 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. 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 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 SOAP faults are used to indicate that an infrastructure error has occurred, such as a problem on eBay's side with database or server going down, or a problem with the client or server-side SOAP framework. Error code can be used by a receiving application to debug a SOAP response message that contains one or more SOAP fault details. Each error code is uniquely defined for each fault scenario. See the eBay documentation for more information. Your application can use error codes as identifiers in your customized error-handling algorithms. Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning). Description of the condition that caused the SOAP fault. 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. The unit of measure (e.g., Pounds). GetItemShipping GetSellerTransactions Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll The system of measurement (e.g., Metric). GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll (in/out) English system of measurement. (in/out) Metric system of measurement. (in) Contains data for controlling pagination in API requests. Pagination of returned data is required for some calls and not needed in or not supported for some calls. See the documentation for individual calls to determine whether pagination is supported, required, or desirable. (in) Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. See the documentation for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). GetAccount GetCategoryListings GetFeedback GetItemsAwaitingFeedback GetItemTransactions GetLiveAuctionBidders GetMyeBayBuying GetMyeBaySelling GetOrders GetSellerTransactions GetWantItNowSearchResults GetLiveAuctionBidders No GetMemberMessages Yes 1 50000 50 GetProductSearchResults GetProductFamilyMembers No 1 400 GetSearchResults No 1 200 200 GetSellerPayments No 200 200 200 GetUserDisputes No GetSellerList Conditionally 100 GetPopularKeywords No (in) Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). GetAccount GetCategoryListings GetFeedback GetItemsAwaitingFeedback GetItemTransactions GetLiveAuctionBidders GetMyeBayBuying GetMyeBaySelling GetOrders GetSearchResults GetSellerTransactions GetWantItNowSearchResults GetLiveAuctionBidders No 0 2147483647 0 GetMemberMessages GetUserDisputes Yes GetProductSearchResults GetProductFamilyMembers No 0 2147483647 0 GetSellerList Conditionally GetSellerPayments No 1 2147483647 1 GetPopularKeywords No 1 Basic type for specifying quantities. 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. The identifier can only contain digits from 0-9 and letters from A-F. The identifier must be 32 characters long. For example, 9CEBD9A6825644EC8D06C436D6CF494B. 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 GetReturnURL GetRuName SetReturnURL 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 GetReturnURL GetRuName SetReturnURL 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 GetReturnURL GetRuName SetReturnURL 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 GetReturnURL GetRuName SetReturnURL Yes Password for the user specified in Username. 64 GetReturnURL GetRuName SetReturnURL Yes Do not return warnings when the application passes unrecognized elements in a request. This is the default value if WarningLevel is not specified. Return warnings when the application passes unrecognized 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 GetReturnURL GetRuName SetReturnURL Yes Password for the user specified in Username. 64 GetReturnURL GetRuName SetReturnURL Yes 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, GetReturnURL, GetRuName, SetReturnURL Yes Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Describes the current status of your application with regard to rules governing the number of times your application can execute API calls. (out) The rule is not set and usage limits do not apply. GetApiAccessRules Conditionally (out) Your application has exceeded its hourly hard limit. GetApiAccessRules Conditionally (out) Your application has exceeded its daily hard limit. GetApiAccessRules Conditionally (out) Your application has exceeded its periodic hard limit. GetApiAccessRules Conditionally (out) Your application has exceeded its hourly soft limit. GetApiAccessRules Conditionally (out) Your application has exceeded its daily soft limit. GetApiAccessRules Conditionally (out) Your application has exceeded its periodic soft limit. GetApiAccessRules Conditionally (out) Reserved for internal or future use. Defines values that describe an application's current status with respect to an API access rule. The rules specify daily, hourly, and periodic usage limits for various eBay Web Services calls. (out) The rule is turned off, and no rule validation was performed. GetApiAccessRules Conditionally (out) The rule is turned on, and rule validation was performed. GetApiAccessRules Conditionally (out) The application is blocked from making requests to the call named in this rule. GetApiAccessRules Conditionally (out) Reserved for internal or future use. Specifies values that describe a transaction on an account. Details of the transaction are returned in AccountEntry. The transaction can be a debit or credit to the account. (out) The reason for the charge is unknown. (out) The fee for listing an item for sale on eBay. (out) The fee for a listing title in boldface font. (out) The fee for adding an optional feature to a listing, such as a reserve fee or a listing upgrade fee. (out) (out) The fee charged when a listed item sells. The fee is a percentage of the final sale price. (out) A payment by check made by a seller to eBay. (out) A payment by credit card made by a seller to eBay. (out) (out) (out) (out) A refund made by eBay to the seller's credit card. (out) A refund made by eBay to the seller by check. (out) A finance charge made to the seller's account, for example, the monthly finance charge added to an account whose balance has not been paid. (out) (out) (out) (out) A credit made by eBay for a duplicate listing. (out) A fee charged by eBay for a partial sale. (out) A reversal of an electronic transfer payment. (out) A one-time payment to the account made by credit card. (out) A fee charged by eBay for a returned check. (out) A fee charged by eBay when a check must be redeposited to collect funds. (out) A cash payment made on the seller's account. (out) A credit issued by eBay for an insertion fee. If a listed item does not sell or results in an Unpaid Item (UPI) dispute, the seller can relist the item. If the item sells the second time, eBay credits the insertion fee. (out) A credit issued by eBay for the Bold listing fee. (out) A credit issued by eBay for the Featured listing fee. (out) (out) A credit issued by eBay for the Final Value Fee. Issued as a result of an Unpaid Item dispute, under some circumstances. (out) A fee charged by eBay when the seller's check does not clear due to insufficient funds. (out) A fee charged by eBay when the seller's check does not clear because the account has been closed. (out) (out) A payment made to the account by money order. (out) An automatic monthly charge of the seller's invoice amount made by eBay to a credit card the seller has placed on file. (out) A one-time payment made by a credit card that is not on file with eBay for automatic monthly payments. (out) (out) (out) A transfer from another account to this account, resulting in a credit to this account. (out) A transfer from this account to another account, resulting in a debit to this account. (out) A credit balance for an account's invoice period, meaning that the seller should not pay. (out) An all-purpose code for debits that are manually applied to auctions, for example, when the credit cannot be applied to an item number (out) An all-purpose code for credits that are manually applied to auctions, for example, when the credit cannot be applied to an item number (out) (out) A note that the credit card is not on file at the customer's request. (out) A credit issued by eBay for an insertion fee when an item is relisted. (out) (out) A fee charged by eBay for adding a gift icon to a listing. The gift icon highlights the item as a good gift and might offer gift services, such as wrapping or shipping. (out) A credit issued by eBay for the gift item fee. (out) A fee charged by eBay for listing an item in the Picture Gallery. A buyer sees a picture of the item when browsing a category, before moving to the item's listing page. (out) A fee charged by eBay for listing an item in the Featured section at the top of the Picture Gallery page. (out) A credit issued by eBay for the Gallery fee charged when the item was listed. (out) A credit issued by eBay for the Featured Gallery fee charged when the item was listed. (out) (out) A credit issued by eBay when listings are not available due to system downtime. The downtime can be a title search outage or a hard outage. See the online help for details. (out) (out) (out) A fee charged by eBay when an item is listed with a reserve price. The fee is credited when the auction completes successfully. (out) A credit issued by eBay for a reserve price auction when the auction completes successfully. (out) (out) (out) (out) A credit issued by eBay to a Store owner who has promoted items outside of eBay. (out) (out) A switch from one billing currency to another. The billing currency can be USD, EUR, CAD, GBP, AUD, JPY, or TWD. (out) A payment made to the account by gift certificate. (out) A payment made to the account by wire transfer. (out) (out) A one-time payment made to the account by electronic transfer. (out) A credit (addition) made by eBay to the seller's account when a payment needs to be adjusted. (out) A debit (deduction) made by eBay to the seller's account when a payment needs to be adjusted. (out) (out) (out) A writeoff of the account charge by eBay because the seller has declared bankruptcy. (out) (out) A writeoff of the account charge by eBay because the seller is deceased. (out) (out) (out) A reversal of a finance charge, made by eBay. The finance charge is added if the seller does not pay the monthly account balance on time. (out) A reversal of a Final Value Fee credit, resulting in the fee being charged to the seller. The Final Value Fee can be credited as a result of an Unpaid Item Dispute. If the buyer later pays, the seller can request a reversal. (out) A fee charged for currency conversion. (out) (out) (out) (out) (out) (out) A monthly payment made by automatic direct debit to the seller's checking account, when the account information is on file. (out) A one-time payment made by direct debit to the seller's checking account, when the account information is not on file, but is provided for this payment. (out) A payment made by direct debit from the seller's checking account when the seller has requested automatic monthly invoice payments. (out) A reversal of a payment made by direct debit from the seller's checking account. (out) A reversal of a payment made by direct debit from a seller's checking account when an item is returned by the buyer. (out) A fee charged by eBay for adding a colored band to emphasize a listing. (out) A credit issued by eBay for a highlight fee on an item's listing. (out) (out) A fee charged for a 30-day real estate listing. (out) A credit for a 30-day real estate listing. (out) (out) (out) A fee charged to sellers who do not provide a credit card or checking account number to verify identify. (out) A credit granted for an EquifaxRealtimeFee. (out) (out) (out) Two accounts with the same owner but different user IDs have been merged into one. (out) (out) (out) The option to send the seller paper invoices has been turned on. (out) The option to send the seller paper invoices has been turned off. (out) (out) An automatic reversal of a Final Value Fee credit. (out) A credit granted by eBay when a title search outage of one hour or longer occurs on the site. (out) A fee charged for listing a lot (one or more items) in a Live Auction catalog. (out) A fee charged for listing an extra item in a Live Auction. (out) (out) A credit for listing an item in a Live Auction catalog. (out) A Final Value Fee charged by eBay when a lot listed on a Live Auction is sold. (out) A refund of a Final Value Fee that was charged when a Live Auction lot was sold. (out) A fee paid by the buyer to the auction house for a purchase in a Live Auction. (out) A refund of the fee paid by a buyer to the auction house for a purchase in a Live Auction. (out) A fee charged for audio or video services provided during the sale of lots at a Live Auction. (out) A refund for audio or video services provided at a Live Auction. (out) A fee charged for a panoramic 360-degree photo in a listing. (out) A fee charged for a slide show of panoramic 360-degree photos. (out) A credit granted to reverse an IPIX photo fee. (out) A credit granted to reverse an IPIX slideshow fee. (out) A fee charged for listing an item for 10 days, rather than one, three, five, or seven days. (out) A credit granted to reverse a 10-day auction fee. (out) (out) (out) A fee charged for a subscription to Auction Assistant Basic. (out) A fee charged for a subscription to Auction Assistant Pro. (out) A credit granted for a subscription fee charged for Auction Assistant Basic. (out) A credit granted for a subscription fee charged for Auction Assistant Pro. (out) A fee charged by eBay for a supersized picture in a listing. (out) A credit issued by eBay for a supersized picture. (out) A fee charged by eBay for the Picture Pack feature. The fee differs according to the number of pictures you use. See the online help for details. (out) A partial credit issued by eBay for the Picture Pack fee. (out) A full credit issued by eBay for the Picture Pack fee. (out) A monthly subscription fee charged for an eBay Store. The fee can be Basic, Featured, or Anchor. (out) A credit issued by eBay for the monthly fee charged for an eBay store. (out) The fee charged by eBay for listing a Fixed Price item. (out) A credit issued by eBay for listing a Fixed Price item. (out) The Final Value Fee credit charged by eBay when a fixed price item sells. (out) A credit issued by eBay for the Final Value Fee for a fixed price item. (out) (out) (out) (out) (out) The fee charged by eBay for creating a Fixed Price listing with a 10-day duration. Fixed Price listings of 1, 3, 5, and 7 days are not charged this fee. (out) A credit issued by eBay for a Fixed Price listing with a 10-day duration. (out) A fee charged by eBay for listing a Buy It Now item. (out) A credit issued by eBay for the fee charged for a Buy It Now listing. (out) A fee for scheduling a listing to start at some later time, up to 3 weeks after the listing is created. (out) A credit made by eBay for the fee charged for scheduling a listing to start after the listing is created. (out) The monthly subscription fee charged for Selling Manager Basic. The monthly charge is billed in advance. (out) The monthly subscription fee charged for Selling Manager Pro. The monthly charge is billed in advance. (out) A one-time credit for a free one-month trial of Selling Manager Basic. (out) A one-time credit for a free one-month trial of Selling Manager Pro. (out) The fee charged for a Good-Til-Cancelled listing in an eBay Store. The charge is made once each 30 days, until the listing ends. (out) A credit for the fee charged for a Good-Til-Cancelled listing in an eBay Store. (out) The fee charged for using a Listing Designer theme and layout template for a listing. The fee is displayed to the seller during the listing process. (out) A credit issued by eBay for a Listing Designer fee. (out) The fee charged for listing an auction item for 10 days. (out) A credit for the fee charged for listing an auction item for 10 days. (out) (out) (out) (out) (out) (out) (out) (out) An addition to the seller's eBay Anything Points account. Each point is equivalent to $0.01. (out) A reduction to the seller's eBay Anything Points account. Each point is equivalent to $0.01. (out) An automatic payment of seller fees from the seller's eBay Anything Points account. (out) A one-time payment of seller fees from the seller's eBay Anything Points account. (out) A reversal of a seller fee payment made from the seller's eBay Anything Points account. (out) A cash payment made from the seller's eBay Anything Points account and credited to the seller's account. (out) A credit (return) to your account of Value-Added Tax previously paid. (out) A debit to your account for a Value-Added Tax charge. (out) (out) (out) (out) (out) (out) (out) (out) A fee charged for the difference between an eBay Store inventory listing fee and an auction listing fee if a Store inventory item sells. (out) A credit for a StoresSuccessfulListingFee. (out) (out) A credit posted to a seller's account for sale of Stores Inventory items by buyers referred to the seller's Store by printed materials and emails outside eBay. (out) The fee charged for adding a subtitle to a listing. The subtitle adds information to the title. (out) A credit of the fee charged for adding a subtitle to a listing. (out) (out) (out) (out) The monthly fee charged for subscribing to Picture Manager. The fee varies according to the level of subscription. (out) A credit granted for a Picture Manageer subscription fee. (out) A fee charged for a basic subscription to Seller Reports. (out) A credit granted for a basic subscription to Seller Reports. (out) A fee charged for a subscription to Seller Reports Plus. (out) A credit granted for a subscription to Seller Reports Plus. (out) (out) (out) (out) The fee for adding a border that outlines a listing with a frame. (out) A credit for the border fee charged for a listing. (out) A fee charged to a seller for upgrading a listing from eBay Germany's Car, Motorcycle, and Special Vehicle categories so that it is also searchable on the mobile.de classifieds site. (out) A monthly subscription fee charged for Sales Reports Plus. (out) A credit granted for a Sales Reports Plus monthly subscription fee. (out) A credit granted for upgrading a listing to make it searchable on the mobile.de platform. (out) A fee charged to owners of eBay Stores who have a sent a marketing email to buyers, for the number of email recipients over the Store's monthly free allocation. The monthly allocation varies according to the type of Store. (out) A credit granted for an email marketing fee. (out) A fee charged for the Picture Show service, which lets buyers browse or see a slide show of 2 or more pictures at the top of the item page. (out) A credit granted for a Picture Show fee. (out) A fee charged for the ProPackBundle feature pack (currently available to US and Canada eBay motor vehicle sellers). (out) A credit granted by eBay for the ProPackBundle feature pack (currently available to US and Canada eBay motor vehicle sellers). (out) A fee charged by eBay for the BasicUpgradePackBundle feature pack. Australia site (site ID 15, abbreviation AU) only. Effective beginning February 22, 2006. (out) A credit granted by eBay for the BasicUpgradePackBundle feature pack. Australia site (site ID 15, abbreviation AU) only. Effective beginning February 22, 2006. (out) A fee charged by eBay for the ValuePackBundle feature pack. Effective beginning February 22, 2006. (out) A credit granted by eBay for the ValuePackBundle feature pack. Effective beginning February 22, 2006. (out) A fee charged by eBay for the ProPackPlusBundle feature pack. Effective beginning February 22, 2006. (out) A credit granted by eBay for the ProPackPlusBundle feature pack. Effective beginning February 22, 2006. (out) The final entry in an account before it is closed or merged with another account. (out) Reserved for future use. (out) A fee charged for extended listing duration. (out) A credit granted by eBay for extended listing duration. (out) The fee for an international listing. (out) A credit issued by eBay for an international listing. (out) A MarketPlace Research fee for expired subscriptions. (out) A MarketPlace Research credit for expired subscriptions. (out) A MarketPlace Research basic subscription fee. (out) A MarketPlace Research basic subscription credit. (out) A MarketPlace Research pro subscription fee. (out) Basic bundle fee. (out) Basic bundle fee credit. (out) A MarketPlace Research pro subscription fee credit. (out) A Vehicle Local subscription fee. (out) A Vehicle Local subscription fee credit. (out) A Vehicle Local insertion fee. (out) A Vehicle Local insertion fee credit. (out) A Vehicle Local final value fee. (out) A Vehicle Local final value fee credit. (out) A Vehicle Local GTC fee. (out) A Vehicle Local GTC fee credit. (out) A fee charged by eBay for listing an item with the Gallery Plus feature enabled. This feature cannot be removed with ReviseItem or RelistItem. However, if the feature is upgraded, for example, to Gallery Featured, the fee for Gallery Plus is refunded and a fee for Gallery Feature is charged instead. (out) A credit issued by eBay when refunding the fee for enabling the Gallery Plus feature. A Gallery Plus credit may be issued if, for example, a user upgrades their feature with ReviseItem or RelistItem to Gallery Featured. In this case, the original Gallery Plus fee is refunded and a Gallery Featured fee is charged instead. Collection of zero, one, or multiple individual detail account entries. Contains one AccountEntry object for each account entry returned. See the schema documentation for AccountEntryType for details on its properties. You can uniquely identify the entries that the GetAccount call returns within the AccountEntries tag. Specifically, the following fields, returned within the AccountEntries tag, can be used in combination as a unique key: AccountEntry.Date, AccountEntry.AccountDetailsEntryType, AccountEntry.ItemID, and AccountEntry.RefNumber. Contains the data for one account entry. (See the schema documentation for AccountEntryType for details on its properties.) GetAccount Conditionally Specifies how account entries should be sorted in a response from eBay. (in) Sort by the AccountEntry.Date value in the response, in ascending order. Same as AccountEntryCreatedTimeAscending. (in) Sort by the AccountEntry.Date value in the response, in ascending order. (in) Sort by the AccountEntry.Date value in the response, in descending order. (in) Sort by the AccountEntry.ItemID value in the response, in ascending order. (in) Sort by the AccountEntry.ItemID value in the response, in descending order. (in) Sort by the value returned in AccountEntry.Description, with entries starting with lowercase letters before entries starting with uppercase letters and each group in alphabetical order. (in) Sort by the value returned in AccountEntry.Description, with entries starting with uppercase letters before entries starting with lowercase letters and each group in reverse alphabetical order. (out) Reserved for internal or future use. Contains the data for a single account detail entry. Each detail entry is a transaction posted to the account and may be: a credit, a debit, or an administrative action (such as an update putting a credit card on file for the account). You can uniquely identify the entries that the GetAccount call returns within the AccountEntries tag. Specifically, the following fields, returned within the AccountEntries tag, can be used in combination as a unique key: AccountEntry.Date, AccountEntry.AccountDetailsEntryType, AccountEntry.ItemID, and AccountEntry.RefNumber. Indicates the type of transaction or reason for the transaction. For example, a value of FeeGallery indicates a debit for listing an item in the Gallery. Possible values are enumerated in the AccountDetailEntryCodeType code list. GetAccount Conditionally A description of the transaction. Returned with compatibility level 387. GetAccount Conditionally Balance after the account entry's credit or debit amount has been applied. Can be 0.00. With compatibility level 387, the value is positive for debits and negative for credits, reversing the sign of earlier versions. GetAccount Conditionally Credit amount for a detail entry. Will be 0.00 if the entry is a debit. Obsolete (not returned) with compatibility level 387 and higher. GetAccount Conditionally Obsolete Date entry was posted to the account, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) GetAccount Conditionally Debit amount for this detail entry. Will be 0.00 if the entry is a credit. Obsolete (not returned) with compatibility level 387 and higher. GetAccount Conditionally Obsolete Gross fees that are assessed by eBay (net fees plus VAT, if any). Returned even if VAT does not apply. With compatibility level 387, the value is positive for debits and negative for credits, reversing the sign of earlier versions. GetAccount Conditionally Item ID (if the account detail entry is associated with an item listing) or 0 (if no item listing is associated with the account entry). 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetAccount Conditionally Memo line for the account entry, can be an empty string. GetAccount Conditionally Net fees that are assessed by eBay, excluding additional surcharges and VAT (if any). Returned even if VAT does not apply. With compatibility level 387, the value is positive for debits and negative for credits, reversing the sign of earlier versions. GetAccount Conditionally eBay reference number for the account entry. May return no value for some account transactions, such as an administrative action like placing the user's credit card on file. You can uniquely identify the entries that the GetAccount call returns within the AccountEntries tag. Specifically, the following fields, returned within the AccountEntries tag, can be used in combination as a unique key: AccountEntry.Date, AccountEntry.AccountDetailsEntryType, AccountEntry.ItemID, and AccountEntry.RefNumber. GetAccount Conditionally VAT rate for the item. When the VATPercent is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a VATPercent, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max precision 3 decimal places. Max length 5 characters. Note: The View Item page displays the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored. Returned for all users, not just VAT users, with GetAccountResponse. GetAccount Conditionally Title of the entry. GetAccount Conditionally Specifies a report format to be used to describe the seller's account. (in) Contains the entries since the last invoice eBay sent to the seller. With LastInvoice, InvoiceDate, BeginDate and EndDate (in GetAccountRequest) are ignored. (in) Contains the entries for a specific invoice, identified by the invoice month and year. With SpecifiedInvoice, you must specify InvoiceDate in GetAccountRequest. However, BeginDate and EndDate are ignored. (in) Contains entries that were posted to the seller's account between two dates. The period covered may cross the boundaries of formal invoices. With BetweenSpecifiedDates, you must specify BeginDate and EndDate in GetAccountRequest. However, InvoiceDate is ignored. (out) Reserved for internal or future use. State of an account of an eBay user. (out) The account is active. (out) The account has been created but is not yet active, pending additional information or processing by eBay. (out) The account is inactive. No new seller account entries would be posted by eBay to the account. (out) Reserved for internal or future use. Summary data for the requesting user's seller account as a whole. This includes a balance for the account, any past due amount and date, and defining data for additional accounts (if the user has changed country of residency while having an active eBay account). Indicates the current state of the account (such as active or inactive). Possible values are enumerated in the AccountStateCodeType code list. GetAccount Conditionally Specifies payment made since the previous invoice, but is returned only if AccountHistorySelection is LastInvoice or Specified Invoice. With compatibility level 387, the value is positive for debits and negative for credits, reversing the sign of earlier versions. GetAccount Conditionally Specifies credits granted since the previous invoice, but is only returned AccountHistorySelection is LastInvoice or Specified Invoice. With compatibility level 387, the value is positive for debits and negative for credits, reversing the sign of earlier versions. GetAccount Conditionally Specifies fees incurred since the last invoice, including tax if applicable. Returned only if AccountHistorySelection is LastInvoice or Specified Invoice. With compatibility level 387, the value is positive for debits and negative for credits, reversing the sign of earlier versions. GetAccount Conditionally Contains the data for one additional account. An AccountSummaryType object may return zero, one, or multiple additional accounts. See the schema documentation for AdditionalAccountType for details on additional accounts. With compatibility level 387, the value is positive for debits and negative for credits, reversing the sign of earlier versions. GetAccount Conditionally Amount past due, 0.00 if not past due. With compatibility level 387, the value is positive for debits and negative for credits, reversing the sign of earlier versions. GetAccount Conditionally First four digits of the bank account the user associated with the seller account (with remainder Xed-out). This may be an empty string depending upon the payment type the user selected for the account (e.g., if no debit-card specified). 4 GetAccount Conditionally Indicates the date and time BankAccountInfo was last modified, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) This may be an empty string depending upon the payment type the user selected for the account (e.g., if no debit-card specified). GetAccount Conditionally Indicates the billing cycle in which eBay sends a billing invoice to the user. A value of 0 (zero) indicates an invoice sent on the last day of the month. A value of 15 indicates an invoice sent on the 15th day of the month. GetAccount Conditionally Expiration date for the credit card selected by the user as payment method for the account, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) Empty string if no credit card is on file or if the account is inactive - even if there is a credit card on file. GetAccount Conditionally Last four digits of the credit card the user selected as payment method for the account. Empty string if no credit is on file. GetAccount Conditionally Indicates the date and time credit card or credit card expiration date was last modified, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) This may be an empty string depending on the payment method the user selected for the account (e.g., Empty string if no credit card is on file.) GetAccount Conditionally Current balance for the account. Can be 0.00, positive, or negative. With compatibility level 387, the value is positive for debits and negative for credits, reversing the sign of earlier versions. GetAccount Conditionally (out) Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. Amount of last invoice. 0.00 if account not yet invoiced. With compatibility level 387, the value is positive for debits and negative for credits, reversing the sign of earlier versions. GetAccount Conditionally Date of last invoice sent by eBay to the user, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) Empty string if this account has not been invoiced yet. GetAccount Conditionally Amount of last payment posted, 0.00 if no payments posted. With compatibility level 387, the value is positive for debits and negative for credits, reversing the sign of earlier versions. GetAccount Conditionally Date of last payment by the user to eBay, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) Empty string if no payments have been posted. GetAccount Conditionally Indicates whether the account has past due amounts outstanding. A value of true indicates that the account is past due. A value of false indicates the account is current. GetAccount Conditionally Indicates the method the user selected to pay eBay with for the account. The values for PaymentMethod vary from one global eBay site to the next. Payment methods are enumerated in the SellerPaymentMethodCodeType code list. GetAccount Conditionally Used to indicate whether the Ad Format feature is enabled for a category. The Ad Format feature is disabled for the category. GetCategoryFeatures ReturnAll Conditionally The Ad Format feature is enabled for the category. GetCategoryFeatures ReturnAll Conditionally The category supports the Ad Format feature only. GetCategoryFeatures ReturnAll Conditionally Reserved for future use. GetCategoryFeatures ReturnAll Conditionally Reserved for future use. GetCategoryFeatures ReturnAll Conditionally Defines the AdFormatEnabled feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (e.g., a boolean value is not returned). (out) Contains contact and other information for one lead. (out) Additional information that the lead wants to tell the seller. Not returned if information is unavailable. GetAdFormatLeads Conditionally (out) Address information for the lead. Not returned if information is unavailable. GetAdFormatLeads Conditionally (out) The time of day when the lead prefers the seller to contact him or her. Not returned if information is unavailable. GetAdFormatLeads Conditionally (out) Email address for the lead. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. GetAdFormatLeads Conditionally (out) First name of the lead. GetAdFormatLeads Conditionally (out) Last name of the lead. GetAdFormatLeads Conditionally (out) Phone number of the lead. Not returned if information is unavailable. GetAdFormatLeads Conditionally (out) Date and time (in GMT) that the lead was submitted. GetAdFormatLeads Conditionally Holds the content of the request. Use to track that a response is returned for every request and to match particular responses to particular requests. AddMemberMessagesAAQToBidder Yes An eBay ID that uniquely identifies a given item. Must be a currently active item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddMemberMessagesAAQToBidder Yes Holds the content of the message. AddMemberMessagesAAQToBidder Yes Contains the response information. Use to track that a response is returned for every request and to match particular responses to particular requests. AddMemberMessagesAAQToBidder Always Indicates the response status (e.g., success). AddMemberMessagesAAQToBidder Always Contains the data for one additional account. An additional account is created when the user has an active account and changes country of registry (i.e., registers with the eBay site for the new country). A new account is created and the old account becomes inactive as an additional account. A user who never changes country of residency while having an account will never have any additional accounts. Indicates the current balance of the additional account. GetAccount Conditionally Indicates the currency in which monetary amounts for the additional account are expressed. GetAccount Conditionally Indicates the unique identifier for the additional account (the account ID). GetAccount Conditionally Indicates who owns the user's address. (in/out) PayPal owns the address. (in/out) eBay owns the address. (out) Reserved for internal or future use. AddressRecordTypeCodeType - Type declaration to be used by other schemas. Codes indicate the address type. (out) Reserved for internal or future use PayPal address status. (out) Reserved for internal or future use. Contains the data for one user 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). 64 GetItem Conditionally RegistrationAddress GetUser Conditionally RegistrationAddress SellerPaymentAddress ReturnAll GetUserContactDetails GetOrders Always GetOrderTransactions none, ReturnAll Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll A concatenation of Street1 and Street2 (only for the RegistrationAddress instance of AddressType). Not applicable to Half.com. Output only. GetBidderList Conditionally ShippingAddress GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally ShippingAddress GetUser Conditionally RegistrationAddress ReturnAll Line 1 of the user's address. Also applicable to Half.com (for GetOrders). 64 GetBidderList Conditionally ShippingAddress GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally ShippingAddress GetAdFormatLeads Conditionally GetItem Conditionally RegistrationAddress GetUser Conditionally RegistrationAddress SellerPaymentAddress ReturnAll GetOrders Always GetOrderTransactions none, ReturnAll Conditionally AddItem RelistItem ReviseItem VerifyAddItem No GetItem Conditionally Line 2 of the user's address. Returned if applicable. Also applicable to Half.com (for GetOrders). 64 GetBidderList Conditionally ShippingAddress GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally ShippingAddress GetItem Conditionally RegistrationAddress GetUser Conditionally RegistrationAddress SellerPaymentAddress ReturnAll GetOrders Always GetOrderTransactions none, ReturnAll Conditionally AddItem RelistItem ReviseItem VerifyAddItem No GetItem Conditionally The name of the user's city. Also applicable to Half.com (for GetOrders). 64 GetAdFormatLeads Conditionally GetBidderList Conditionally ShippingAddress GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally ShippingAddress GetItem Conditionally RegistrationAddress GetUser Conditionally RegistrationAddress SellerPaymentAddress ReturnAll GetOrders GetUserContactDetails Always GetOrderTransactions none, ReturnAll Conditionally Reserved for future use. AddItem RelistItem ReviseItem VerifyAddItem No GetItem Conditionally The region of the user's address. Also applicable to Half.com (for GetOrders). 64 GetAdFormatLeads Conditionally GetBidderList Conditionally ShippingAddress GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally ShippingAddress GetItem Conditionally RegistrationAddress GetUser Conditionally RegistrationAddress SellerPaymentAddress ReturnAll GetOrders GetUserContactDetails Always GetOrderTransactions none, ReturnAll Conditionally The country code of the user. Also applicable to Half.com (for GetOrders). GetBidderList GetUserPreferences GetUser Conditionally GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally RegistrationAddress ShippingAddress none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally ShippingAddress GetAllBidders GetHighBidders GetOrders GetUserContactDetails Always GetOrderTransactions none, ReturnAll Conditionally SetUserPreferences No The name of the user's country. Also applicable to Half.com (for GetOrders). GetBidderList Conditionally ShippingAddress GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally ShippingAddress GetItem Conditionally RegistrationAddress GetUser Conditionally RegistrationAddress SellerPaymentAddress ReturnAll GetOrders Always GetOrderTransactions none, ReturnAll Conditionally User's primary phone number. Also applicable to Half.com (for GetOrders). GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally ShippingAddress GetBidderList Conditionally ShippingAddress GetItem Conditionally RegistrationAddress GetUser Conditionally RegistrationAddress SellerPaymentAddress ReturnAll GetOrders GetUserContactDetails Always GetOrderTransactions none, ReturnAll Conditionally Reserved for future use. AddItem RelistItem ReviseItem VerifyAddItem No GetItem Conditionally Reserved for future use. GetItem Conditionally Reserved for future use. AddItem RelistItem ReviseItem VerifyAddItem No GetItem Conditionally Reserved for future use. AddItem RelistItem ReviseItem VerifyAddItem No GetItem Conditionally Reserved for future use. AddItem RelistItem ReviseItem VerifyAddItem No GetItem Conditionally Reserved for future use. GetItem Conditionally Reserved for future use. AddItem RelistItem ReviseItem VerifyAddItem No GetItem Conditionally Reserved for future use. AddItem RelistItem ReviseItem VerifyAddItem No GetItem Conditionally User's postal code. Also applicable to Half.com (for GetOrders). 12 GetAdFormatLeads GetBidderList Conditionally GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally RegistrationAddress ShippingAddress none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally ShippingAddress GetUser Conditionally RegistrationAddress SellerPaymentAddress ReturnAll GetMyeBaySelling Conditionally SoldList GetAllBidders GetHighBidders GetOrders Always GetOrderTransactions none, ReturnAll Conditionally ID assigned to the address in the eBay database. For GetOrders, applies only to Half.com. GetOrders Always GetOrderTransactions none, ReturnAll Conditionally The realm to which the address belongs (e.g. eBay vs PayPal). For GetOrders, applies only to Half.com. GetOrderTransactions none, ReturnAll Conditionally GetOrders Always PayPal address status. Not applicable to Half.com. ID assigned to the address by the owner of the address (fitting only if the address is owned by PayPal; see AddressOwner). Also applicable to Half.com (for GetOrders). 20 GetOrders Always GetOrderTransactions none, ReturnAll Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll Seller's international name that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com. GetUser Conditionally SellerPaymentAddress 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 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 GetBidderList Conditionally ShippingAddress User's company name. Only returned if available. Not applicable to Half.com. GetUserContactDetails Always GetBidderList Conditionally ShippingAddress GetItem Conditionally RegistrationAddress AddItem RelistItem ReviseItem VerifyAddItem No GetItem Conditionally Indicates the nature of the address (e.g., residential or business). Not applicable to Half.com. Basic type for specifying monetary amounts. 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. Details such as prices, fees, costs, and payments are specified as amount types. Currency in which the monetary amount is specified. Note that SendInvoice does not support this attribute for ShippingInsuranceCost, ShippingServiceCost, ShippingServiceAdditionalCost, SalesTaxAmount, and InsuranceFee. GetFinanceOffers GetItemRecommendations GetItemShipping GetMyeBaySelling Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetMyeBayBuying Always TotalWinningCost TotalWonCost none, ReturnSummary, ReturnAll GetMyeBayBuying Conditionally BestOffer BuyItNowPrice ConvertedMaxBid CurrentPrice MaxBid SecondChanceOffer ShippingServiceCost StartPrice Subtotal none, ReturnAll RespondToBestOffer ReviseCheckoutStatus No GetBestOffers GetOrders InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected Always GetOrderTransactions InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected none Always GetOrders InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected Conditionally GetOrderTransactions InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected none Conditionally PlaceOffer Always ConvertedCurrentPrice CurrentPrice PlaceOffer Conditionally MinimumToBid AddItem AddLiveAuctionItem AddSecondChanceItem GetStoreOptions RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem VerifyAddSecondChanceItem Yes Always RelistItem No AddTransactionConfirmationItem Yes Contains the definition of a rule that governs the number of times your application can access the eBay API (invoke a call) on an hourly, daily, or periodic basis. The name of the call that has an access rule. Can be a call name (e.g., AddItem), ApplicationAggregate (returns totals for all calls), or PasswordAuthenticationLimiter. GetApiAccessRules Always Whether access to this call counts toward the application's aggregate limit for all calls. GetApiAccessRules Always The number of calls per day that your application can make to this call before being refused. The day starts at midnight, 00:00:00 PST. Note that the time is in PST, not GMT. GetApiAccessRules Always The number of calls per day that your application can make to this call before you receive a warning. The day starts at midnight, 00:00:00 PST. GetApiAccessRules Always The number of times your application has used this call today. GetApiAccessRules Always The number of calls per hour that your application can make to this call before being refused. Each count begins on the hour, at 12:00:00, 1:00:00, and so on. GetApiAccessRules Always The number of calls per hour that your application can make to this call before you receive a warning. Each count begins on the hour, at 12:00:00, 1:00:00, and so on. GetApiAccessRules Always Number of times your application has executed this call this hour. GetApiAccessRules Always The length of time before your application's perodic usage counter restarts for this call. If the number of calls you make exceeds the periodic hard limit before the current period ends, further calls will be refused until the next period starts. Possible values: -1 (Periodic limit not enforced, could be any negative integer), 0 (Calendar month), 30 (Number of days, could be any positive integer). If the period is based on the calendar month, the usage counters restart on the same day of every month, regardless of the number of days in the month. GetApiAccessRules Always Number of calls per period that your application may make before a call is refused, if the periodic limit is enforced. The length of the period is specified in Period. GetApiAccessRules Always Number of calls per period that your application may make before you receive a warning, if the periodic limit is enforced. The length of the period is specified in Period. GetApiAccessRules Always Number of calls that your application has already made this period. Returns 0 if the periodic access rule has not been configured for the application. The length of the period is specified in Period. The start date of the period is specified in PeriodicStartDate. GetApiAccessRules Always The time (in GMT) when this access rule's period started. The period starts at midnight Pacific time. For example, if the period begins on June 29 in 2005 when California is on Pacific Daylight Time, the GMT value returned would be 2005-06-29T07:00:00.000Z If the period begins on December 29 in 2005 when California is on Pacific Standard Time, the GMT value returned would be 2005-12-29T08:00:00.000Z. Only returned when the eBay Developers Program has configured the start date for the access rule. The start date can vary per application and per call name (i.e., per access rule). GetApiAccessRules Conditionally The date and time this access rule was last modified. Indicates last time that values for RuleCurrentStatus, RuleStatus, URL, or EnforceURL changed. GetApiAccessRules Always Your application's current status for this rule, including whether the rule is set, the hourly limit is exceeded, the daily limit is exceeded, or the periodic limit is exceeded. GetApiAccessRules Always The status of the access rule, including whether the rule is turned on or off, or whether the application is currently blocked from using this call. No effect if RuleCurrentStatus=NotSet. GetApiAccessRules Always (in/out) Specifies preferences describing how notifications are delivered to an application. Note that notifications are subject to Anti-Spam rules. See Anti-Spam Rules in the eBay Web Services Guide for more information about these rules. (in/out) The URL where eBay delivers all notifications sent to the application. For delivery to a server, the URL begins with http:// or https:// and must be well formed. Use a URL that is functional at the time of the call. For delivery to an email address, the URL begins with mailto: and specifies a valid email address. SetNotificationPreferences No GetNotificationPreferences Conditionally (in/out) A token indicating whether notifications are enabled or disabled. If you disable notifications, the application does not receive them, but notification preferences are not erased. SetNotificationPreferences No GetNotificationPreferences Conditionally (in/out) The email address where eBay sends all application markup and markdown event notifications. When setting the email address, input must be in the format mailto://youremailaddress@yoursite.com (with the mailto:// prefix). The application has to subscribe to recieve these events using the AlertEnable field. Length of valid email ids SetNotificationPreferences No GetNotificationPreferences Conditionally (in/out) A token indicating whether markup and markdown alerts are enabled or disabled. SetNotificationPreferences No GetNotificationPreferences Conditionally (in/out) If this field is specified, the value must be eBLSchemaSOAP. SetNotificationPreferences No GetNotificationPreferences Conditionally (in/out) The means of receipt of notification. In most cases, it is Platform (typical API calls and web interaction), so this is the default, if not specified. For wireless applications, use SMS. SetNotificationPreferences No GetNotificationPreferences Conditionally CN Reserved for future use. Only applicable to Half.com. Not applicable to eBay listings. You can revise this field for Half.com listings. AddItem VerifyAddItem Yes ReviseItem No GetOrders Always Item Specifics data returned from the Suggested Attributes engine. A list of attribute sets containing recommended attributes and values. Returned from GetItemRecommendations when the Suggested Attributes engine is used See the eBay Web Services guide for additional details. GetItemRecommendations Conditionally (in/out) Applicable for listings that include eBay's Item Specifics or Pre-filled Item Information features. A list of attribute sets. An attribute set contains a list of attributes that describe category-specific aspects or features of an item in a standardized way. See the Developer's Guide for more information. In item-listing requests, this property is required if attributes are identified as required in the characteristics set meta-data. See the Developer's Guide for information about characteristics meta-data and how to determine when attributes are required. (in/out) Contains a list of attributes that describe category-specific aspects or features of an item in a standardized way. For the AddItem family of calls and GetItem, an AttributeSetArrayType 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 characteristics sets. If they are mapped to the same characteristics set, the AttributeSetArrayType can contain one full attribute set. An AttributeSetArrayType can also contain any number of additional site-wide attribute sets. In item-listing requests, this property is required if attributes are identified as required in the characteristics set meta-data. See the Developer's Guide for information about characteristics meta-data and validation rules that are applicable when listing items. Not applicable to Half.com. AddItem AddLiveAuctionItem GetItemRecommendations VerifyAddItem Conditionally GetSearchResults RelistItem ReviseItem ReviseLiveAuctionItem No GetBidderList GetCategoryListings GetSearchResults GetItemRecommendations Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll (in/out) A set of salient aspects or features that describe an item in a standardized way. Most commonly used in the Item Specifics section of a listing. See the Developer's Guide information on working with Item Specifics and Pre-filled Item Information. See the Developer's Guide for information about characteristics meta-data and how to determine when attributes are required. 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 attrribute meta-data, how to determine the valid attributes for a category, and how to determine whether attributes are required. 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. For GetCategoryListings, this returns the item condition only (and it is only returned if IncludeCondition = true in the request). Not applicable to Half.com. AddItem AddLiveAuctionItem GetItemRecommendations VerifyAddItem Conditionally GetSearchResults RelistItem ReviseItem ReviseLiveAuctionItem No GetBidderList GetCategoryListings GetItemRecommendations GetSearchResults Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll 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. For GetCategoryListings, you can ignore this value. Not applicable to Half.com. AddItem AddLiveAuctionItem GetItemRecommendations VerifyAddItem Conditionally GetSearchResults RelistItem ReviseItem ReviseLiveAuctionItem No GetBidderList GetCategoryListings GetItemRecommendations GetSearchResults Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll 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. 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. AddItem AddLiveAuctionItem GetItemRecommendations VerifyAddItem Conditionally GetSearchResults RelistItem ReviseItem ReviseLiveAuctionItem No GetBidderList GetItemRecommendations Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll 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. 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 AddLiveAuctionItem GetItemRecommendations VerifyAddItem Conditionally GetSearchResults RelistItem ReviseItem ReviseLiveAuctionItem No GetBidderList GetCategoryListings GetItemRecommendations GetSearchResults Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll GetOrders 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 AddLiveAuctionItem GetItemRecommendations VerifyAddItem AttributeSetArray Conditionally GetSearchResults RelistItem ReviseItem ReviseLiveAuctionItem AttributeSetArray No GetBidderList GetCategoryListings GetItemRecommendations GetSearchResults Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll 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 GetCategoryListings, this returns the value "Condition" to identify the item condition attribute. 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 GetItemRecommendations VerifyAddItem AttributeArray Conditionally ReviseItem AttributeArray No GetCategoryListings Conditionally GetOrders Always Container for a list of AuthenticationEntries. Can contain zero, one, or multiple AuthenticationEntryType objects. Contains the data properties that define one authentication entry. Multiple AuthenticationEntry fields can be returned. GetReturnURL Conditionally A set of application-level authentication preferences and related data that you configure to support the user authentication and authorization process. Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth A URL that you set up in order to determine when a user's authentication and authorization process succeeded. After a user signs into eBay and authorizes your application to execute secure calls on their behalf, eBay redirects the user's browser to this URL and, if TokenReturnMethod is set to Redirect, appends the user's authentication token plus other data that you specified to identify the user. 500 SetReturnURL No GetReturnURL Conditionally Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Your privacy policy URL, which is shown to end users on the eBay sign-in page. 500 SetReturnURL No GetReturnURL Conditionally Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth A URL that you set up in order to determine when a user's authentication and authorization process did not succeed. After a user signs into eBay but chooses NOT to authorize your application to execute secure calls on their behalf, eBay redirects the user's browser to this URL and appends data that you specified to identify the user (but does not return an authentication token). 500 SetReturnURL No GetReturnURL Conditionally Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth A unique identifier associated with application and the combination of URLs within this authentication entry. Unique across all applications that execute eBay Web Services calls. For convenience, you can call GetRuName to generate a unique value. 255 SetReturnURL Yes GetReturnURL Always Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Specifies whether to return the token in the HTTP response stream sent to the accept URL, or to make it available for retrieval via FetchToken. SetReturnURL No GetReturnURL Conditionally Authentication & Authorization http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth BalanceCodeType - Type declaration to be used by other schema. This code identifies the types of balances in an account, e.g., a PayPal account. (out) Custom Code. (out) Reserved for internal or future use. Defines the BasicUpgradePack feature (a feature pack). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Australia site (site ID 15, abbreviation AU) only. Indicates the action taken by a seller for a best offer. (in/out) To accept something. To decline something. To counter offer. Reserved for internal or future use. A collection of Best Offers. Empty if there are no best offers. A container of details about a best offer. GetBestOffers RespondToBestOffer Always Defines the BestOfferAutoDeclineEnabled feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Defines the BestOfferCounterEnabled feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Container for BestOffer properties associated with the item. The number of best offers made for this item, if any. GetBidderList GetSellerList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally Whether best offer is enabled for this 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 active best offers, you cannot change the value to false. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetSellerEvents Conditionally none, ReturnAll (GetMyeBayBuying only) Indicates the latest BestOffer the user has provided for the item . GetMyeBayBuying BestOfferList Conditionally none, ReturnSummary, ReturnAll (GetMyeBayBuying only) Indicates the status of the latest BestOffer the user has provided for the item . GetMyeBayBuying Conditionally BestOfferList none, ReturnSummary, ReturnAll Indicates the best offer type of the latest BestOffer the user has provided for the item . Defines the BestOfferEnabled feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Unique identifier for a best offer (to differentiate from other best offers for the same item). The status of the best offer. The best offer is awaiting seller response or will naturally expire after 48 hours. GetMyeBayBuying Conditionally BestOfferList none, ReturnSummary, ReturnAll The best offer was accepted by the seller. GetMyeBayBuying Conditionally BestOfferList none, ReturnSummary, ReturnAll The best offer was rejected by the seller. GetMyeBayBuying Conditionally BestOfferList none, ReturnSummary, ReturnAll The best offer expired after 48 hours due to no action by the seller. GetMyeBayBuying Conditionally BestOfferList none, ReturnSummary, ReturnAll The best offer was retracted by the buyer. GetMyeBayBuying Conditionally BestOfferList none, ReturnSummary, ReturnAll The best offer was ended by an administrator. GetMyeBayBuying Conditionally BestOfferList none, ReturnSummary, ReturnAll Retrieve active best offers only. GetMyeBayBuying Conditionally BestOfferList none, ReturnSummary, ReturnAll Retrieve all counter best offers. Retrieve all best offers (including declined offers, etc.). (out) Reserved for internal or future use. Details about a best offer. (out) An id to distinguish this best offer from other best offers made on the item. GetBestOffers Always (out) Date and time (in GMT) the offer naturally expires (if the seller has not accepted or declined the offer). GetBestOffers Always (out) Information about the buyer who made the best offer. GetBestOffers Always (in/out) The amount of the best offer. GetBestOffers Always (out) The state of the offer. GetBestOffers Always (out) The number of items for which the buyer is making an offer. GetBestOffers Always (in/out) Text message provided by buyer when placing best offer. 500 (in bytes) GetBestOffers Conditionally (in/out) Text response to buyer from seller. 500 (in bytes) GetBestOffers Conditionally (out) The best offer type. GetBestOffers Always (out) The status of the call, either Success or Failure. RespondToBestOffer Always The offer type of the best offer. The buyer has placed best offer on the item. The buyer has made a counter offer. The seller has made a counter offer. (out) Reserved for internal or future use. BidActionCodeType - Type declaration to be used by other schema. These are the possible codes for types of bid. Unknown (in/out) Bid. The offer is being or was placed on a competitive-bidding listing (a Chinese or Dutch auction). (out) Not used. (out) Retraction. The offer was retracted by the user who extended the offer. (Must be done on the eBay site, not possible through the API.) (out) Auto-retraction. The offer was auto-retracted. (Must be done on the eBay site, not possible through the API.) (out) Cancelled. The offer was cancelled. (Must be done on the eBay site, not possible through the API.) (out) Auto-cancel. The offer was auto-cancelled. (Must be done on the eBay site, not possible through the API.) (out) Absentee. The offer placed was an absentee bid. (Must be done on the eBay site, not possible through the API.) (out) BuyItNow. The offer resulted in the successful exercise of the Buy It Now option for a Chinese auction. (in/out) Purchase. The offer is being or was placed on a fixed-price listing. (out) Reserved for internal or future use. Mulitple bidders can be approved with one call. The settings the seller specifies about one user when approving or denying that user's request to bid on items in the seller's Live Auctions catalog. ApproveLiveAuctionBidders No Information that a Live Auction seller selects when approving or denying a user who wants to bid on items in the seller's Live Auctions catalog. User ID for the bidder to be approved. Only users that have requested approval can be approved. That is, the seller cannot approve a bidder that has not requested approval via the web flow. When you are approving bidders, if you pass in multiple BidApproval entries with duplicate UserID values, the last entry with that UserID is used for the request (and the earlier duplicate UserID entries are ignored). ApproveLiveAuctionBidders Yes Amount that seller is approving the bidders for. This field is required if the seller has requested for the bidders to enter the amount to be approved. ApproveLiveAuctionBidders Conditionally Comments entered by seller when an appoval request is declined. This is required if seller is setting Status="Denied". ApproveLiveAuctionBidders Conditionally Sellers set the status. See BidderStatusCodeType for possible values. ApproveLiveAuctionBidders Yes A collection of Bidder Detail. Details about a Live Auctions bidder. Returned if at least one bidder has requested approval. GetLiveAuctionBidders Conditionally Contains the data for a user who is interested in bidding on items in a Live Auctions catalog. ID of the user requesting approval. GetLiveAuctionBidders Always E-mail address of the bidder. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. Returned as CDATA. When an email address can not be returned, the string "Invalid Request" is returned instead. GetLiveAuctionBidders Always Aggegate feedback score for the specified user. Feedback score is only return if the user has not chosen to make his or her feeback private. GetLiveAuctionBidders Conditionally Total count of negative feeback entries from unique users who have left feedback for the user. GetLiveAuctionBidders Always Total count of positive feeback entries from unique users who have left feedback for the user. GetLiveAuctionBidders Always Contains the bidder details that match the bidder query passed in the request. Always returned when bidder search results are found. GetLiveAuctionBidders Always Contains a seller's preferences for receiving bidder notices. If true, sends the seller a notice containing the contact information for unsuccessful bidders. GetUserPreferences Conditionally SetUserPreferences No This code identifies the status of the Bidder's request (in/out) Bidder's request is approved. ApproveLiveAuctionBidders GetLiveAuctionBidders No (in/out) Bidder's request is denied. ApproveLiveAuctionBidders GetLiveAuctionBidders No (out) Bidder's request is pending. GetLiveAuctionBidders No (out) Reserved for internal or future use. BidderTypeCodeType - Type declaration to be used by other schema. Specifies the whether to retrieve all bidders for ended or open listings. (in) Retrieve all bidders for ended or open listings. (in) Retrieve all high bidders. (out) Reserved for internal or future use. Converted value of the value in MaxBid, in the currency indicated by SiteCurrency. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Under conditions where this value would be N/A on the eBay site, this element is not returned at all. GetMyeBayBuying Conditionally BidList LostList WonList Indicates the maximum amount the user has agreed to pay for the item when the user last submitted a bid. Under conditions where this value would be N/A on the eBay site, this element is not returned at all. GetMyeBayBuying Conditionally BidList LostList WonList (GetMyeBay only) Number of items from the listing the user agreed to purchase with a bid. For single-item listings, always 1. For multi-item listings, will be between 1 and the number of items offered in the auction. Number of items purchased so far. GetMyeBayBuying Conditionally BidList LostList WonList (GetMyeBay only) Used mainly for Dutch auction. For an active listing, number of items the user stands to win if the user is a current winning bidder. For an ended listing, number of items the user actually won. In both cases, the number may be less than that returned in QuantityBid as the lowest winning bidder in a Dutch auction might not win the number of items the user has bid on. GetMyeBayBuying Conditionally BidList LostList WonList (GetMyeBay only) Indicates whether the user is the current high bidder in a currently active listing. (out) Reserved for internal or future use. BuyerProtectionCodeType - Type declaration to be used by other schema. Indicates the status of the item's eligibility for the Buyer Protection Program. (out) Item is ineligible (e.g., category not applicable). (out) Item is eligible per standard criteria. (out) Item marked ineligible per special criteria (e.g., seller's account closed). (out) Item marked eligible per other criteria. (out) Reserved for internal or future use. Container for all buyer requirements in listing calls. (in/out) If true, blocks bidders who are registered in countries to which the seller has specified he will not shipo. Ignored as input if the application uses version 451 or older. false AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem GetSellerList Conditionally (in/out) If true, blocks bidders with a feedback score of 0 who attempt to bid on Buy It Now items worth 100 RMB or more. Ignored as input if the application uses version 451 or older. This requirement is only enabled for the CN site. false CN AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem GetSellerList Conditionally (in/out) If true, blocks bidders with this feedback score or lower. Ignored as input if the application uses version 451 or older. Valid values: -3, -2, -1. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetSellerList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally (in/out) If true, blocks bidders who have received two unpaid item strikes in the last 30 days. Ignored as input if the application uses version 451 or older. false AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem GetSellerList Conditionally (in/out) A means of limiting unpaying, low feedback bidders. Ignored as input if the application uses version 451 or older. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem GetSellerList Conditionally (in/out) If true, only bidders with PayPal accounts linked to eBay may bid. false AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetSellerList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally (in/out) A means of limiting unverified bidders. Ignored as input if the application uses version 451 or older. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem GetSellerList Conditionally Contains information about a user as a buyer. Contains the address of the buyer in the transaction, to which the seller would ship the item(s). See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only. GetAllBidders GetHighBidders Always GetBidderList GetMyeBaySelling Conditionally GetOrderTransactions Conditionally none, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll Information about zero or more buying guides and the site's buying guide hub. Buying guides contain content about particular product areas, categories, or subjects to help buyers decide which type of item to purchase based on their particular interests. Multiple buying guides can be returned. See the eBay Web Services Guide for additional information. Information that identifies a buying guide. A buying guide contains content about particular product areas, categories, or subjects to help buyers decide which type of item to purchase based on their particular interests. Buying guides are useful to buyers who do not have a specific product in mind. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. GetCategoryListings GetSearchResults Conditionally URL of the buying guide home page for the site being searched. Your application can present this URL as a link. Optionally, you can use a value like "See all buying guides" as the link's display name. GetCategoryListings GetSearchResults Conditionally Information that identifies a buying guide. A buying guide provides content about particular product areas, categories, or subjects to help buyers decide which type of item to purchase based on their particular interests. Buying guides are useful to buyers who do not have a specific product in mind. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. Display name of the buying guide. Typically similar to the name of the category or product finder associated with the buying guide. GetCategoryListings GetSearchResults Conditionally URL for the buying guide. Your application can present this as a link. Use the value of Name as the link's display name. GetCategoryListings GetSearchResults Conditionally Identifies the category (if any) that is associated with the buying guide. This can be a category that is higher or lower in the hierarchy than the category specified in the request. For a matching categories search, you can use this information to determine the order that the buying guides are returned in when multiple guides are found. Optionally, you can use this information to determine where to present the buying guide link in your application. Not returned for product finder searches. 10 GetCategoryListings GetSearchResults Conditionally Identifies the product finder (if any) that is associated with the buying guide. Only returned for product finder searches. GetSearchResults Conditionally The number of items the user has bid on. GetMyeBayBuying Always none, ReturnSummary, ReturnAll The number of items the user has bid on and is winning, but that have not yet ended. GetMyeBayBuying Always none, ReturnSummary, ReturnAll The total cost of items the user is presently winning. GetMyeBayBuying Always none, ReturnSummary, ReturnAll The number of items the user has bid on and won. GetMyeBayBuying Always none, ReturnSummary, ReturnAll The total cost of items the user has bid on and won. GetMyeBayBuying Always none, ReturnSummary, ReturnAll The time period for which won items are displayed. Default is 31 days. GetMyeBayBuying Always none, ReturnSummary, ReturnAll The number of items the user has made best offers on. GetMyeBayBuying Always none, ReturnSummary, ReturnAll Calculated Shipping Charge Options Charge the actual shipping cost and my full packaging and handling fee for each item. Charge the actual shipping cost and a packaging and handling fee of X amount for the entire order. Reserved for internal or future use. Calculated shipping preferences for the user. The calculated shipping amount for the entire order. GetUserPreferences Conditionally SetUserPreferences No Specifies whether to charge the actual shipping and handling cost for the entire order or for each item. GetUserPreferences Conditionally SetUserPreferences No Specifies whether to calculate the actual rate shipping based on the combined item weight or the individual item weight. GetUserPreferences Conditionally SetUserPreferences No (in/out) Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Flat and calculated shipping. GetUserPreferences Conditionally SetUserPreferences No Calculated Shipping Rate Options. Calculate the Actual Shipping Rate from Combined Item Weight Calculate the Actual Shipping Rate from Individual Item Weight Reserved for internal or future use. (in/out) Details pertinent to one or more items for which calculated shipping 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. (in/out) Postal code for the location from which the package will be shipped. For calculated shipping only. Use Item.PostalCode to specify the location of the item and where it will be shipped from. The value of Item.PostalCode overrides any value specified with OriginatingPostalCode, and will be used to calculate shipping costs. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none GetBidderList GetItemShipping Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll (in/out) Depth of the package needed to ship the items. 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. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetOrderTransactions Conditionally none GetBidderList GetItem GetItemShipping Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll (in/out) Length of the package needed to ship the items. 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. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList GetItem GetItemShipping Conditionally GetOrderTransactions Conditionally none GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll (in/out) Width of the package needed to ship the items. 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. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList GetItem GetItemShipping Conditionally GetOrderTransactions Conditionally none GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll (in/out) Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). For calculated shipping only. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetSellerList Conditionally ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none GetBidderList GetItemShipping Conditionally GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll (in/out) 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. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetOrderTransactions Conditionally none GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItemShipping Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll (in/out) The nature of the package used to ship the item(s). Required for calculated shipping only. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItemShipping Conditionally GetOrderTransactions Conditionally none GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll (in/out) An aspect of shipping weight whose value depends on the unit attribute. The following would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor> See http://www.ups.com for UPS' maximum weight allowed. Above this maximum, the shipping type would become Freight. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package weight exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none GetBidderList GetItemShipping Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll (in/out) An aspect of shipping weight whose value depends on the unit attribute. The following would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor> For calculated shipping only. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList GetItemShipping Conditionally GetOrderTransactions Conditionally none GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll Container for a list of offers. May contain zero, one, or multiple OfferType objects, each of which represents one offer extended by a user on a listing. Contains the data for one offer. This includes: data for the user making the offer, the amount of the offer, the quantity of items being bought from the listing, the type of offer being made, and more. Container for a list of offers. May contain zero, one, or multiple OfferType objects, each of which represents one offer extended by a user on a listing. Contains the data for one offer. This includes: data for the user making the offer, the amount of the offer, the quantity of items being bought from the listing, the type of offer being made, and more. Container for a list of categories. Contains the data for one category. See the schema documentation for CategoryType for details on its properties and their meanings. For GetCategories, not returned if no detail level is specified. GetCategories Always ReturnAll GetCategoryListings GetPopularKeywords Always GetCategory2CS Always MappedCategoryArray GetCategory2CS Conditionally UnmappedCategoryArray GetSearchResults Conditionally The Detail Level argument for GetCategories allows the following settings to control the detail level of the result set. Return all available data. Return the category feature definitions only. (out) Reserved for internal or future use. A container node that identifies a category that has one of the features specified in FeatureID (in GetCategoryFeaturesRequest). Specifies the identifier of the category that has the feature. 10 GetCategoryFeatures ReturnAll Conditionally Identifies the listing duration set that applies to the category. GetCategoryFeatures ReturnAll Conditionally Indicates whether sellers are required to specify shipping tems for this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether best offers are allowed for this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether DutchBIN are allowed for this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether a bidder must consent to the bid by confirming that he or she read and agrees to the terms in eBay's privacy policy. GetCategoryFeatures ReturnAll Conditionally Indicates whether or not it is possible to enhance a listing by putting it into a rotation for display on a special area of the eBay home page. Support for this feature varies by site. Item or feedback restrictions may apply. GetCategoryFeatures ReturnAll Conditionally Indicates whether ProPackBundle (a feature pack) is enabled for this category. GetCategoryFeatures ReturnAll Conditionally Indicates whether the Basic Upgrade Pack bundle feature is enabled for this category. Australia site (site ID 15, abbreviation AU) only. Effective beginning February 22, 2006. GetCategoryFeatures ReturnAll Conditionally Indicates whether ValuePack bundle (a feature pack) is enabled for this category. GetCategoryFeatures ReturnAll Conditionally Indicates whether the ProPackPlus bundle (a feature pack) is enabled for this category. GetCategoryFeatures ReturnAll Conditionally Indicates whether the Ad Format feature is enabled for this category. GetCategoryFeatures ReturnAll Conditionally Indicates whether or not the digital delivery listing option is available for this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether counter offers are allowed on best offers for this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether auto decline for best offers are allowed for this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether LocalMarketSpecialitySubscription feature is supported for this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether LocalMarketRegularSubscription feature is supported for this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether LocalMarketPremiumSubscription feature is supported for this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether LocalMarketNonSubscription feature is supported for this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether listings in this category are eligible for eBay Express (assuming other item and user eligibility requirements are also met). Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether a listing requires a picture (or gallery image) in order to qualify for eBay Express when listed in this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether a listing requires the Item Condition to be specified (using Item Specifics in AttributeSetArray) in order to qualify for eBay Express when listed in this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally Indicates whether Minimum Reserve Price is enabled for this category. Returned only if this category overrides the site default. Beginning mid- to late June, 2006, on the Germany, Austria, Belgium French, and Belgium Dutch sites, Minimum Reserve Price is supported for the Art and Antiques, Watches and Jewelry, and Motorbikes categories. GetCategoryFeatures ReturnAll Conditionally Reserved for future use. GetCategoryFeatures ReturnAll Conditionally Indicates whether the Transaction Confirmation Request feature is supported for this category. Returned only if this category overrides the site default. GetCategoryFeatures ReturnAll Conditionally A set of financing offers, each valid within one particular category. A financing offer valid within a particular category. GetCategory2FinanceOffer ReturnAll Always A financing offer valid within a particular category. The unique ID for the financing offer. Call GetFinanceOffers using the FinanceOfferID to get more information about the offer. GetCategory2FinanceOffer ReturnAll Always The category within which the financing offer is valid. 10 GetCategory2FinanceOffer ReturnAll Always CategoryListingsOrderCodeType - Type declaration to be used by other schema. This code identifies the CategoryListingsOrder codes (e.g., for GetCategoryListings request) to be used to filter the returned data in the ways enumerated below. (in) Applies no filter. (in) Returns items that were listed in the past 24 hours. (in) Reserved for internal use. (in) Reserved for internal use. (in) Sort items by price (lowest first) (in) Sort items by price (highest first) (in) Sort items by distance (out) Reserved for internal or future use. CategoryListingsSearchCodeType - Type declaration to be used by other schema. Used to filter returned item listings to just those that are featured or super-featured. (in) Return only featured item listings. (in) Return only super-featured item listings. (out) Reserved for internal or future use. Mapping between an old category ID and an active category ID. Identifier for an old category that has been combined with an active category. Unique for the site. These IDs correspond to older category IDs that calls like GetCategories have returned in the past. In GetCategoryMappings, this is always returned when CategoryMapping is returned. GetCategoryMappings Conditionally Identifier for an active category. Unique for the site. These IDs correspond to the current IDs in the category hierarchy (returned from GetCategories and related calls). Multiple mappings can specify the same active category ID, because different old IDs can be mapped to the same active category. See "Mapping Categories on the Client Side" in the eBay Web Services guide. In GetCategoryMappings, this is always returned when CategoryMapping is returned. GetCategoryMappings Conditionally Container for data on one listing category. If true, the category supports best offers. If false or not present, the category does not support best offers. GetCategories Conditionally ReturnAll If true, indicates that the category supports Immediate Payment. If false or not present, the category does not support Immediate Payment. GetCategories Conditionally ReturnAll If true, the category supports business-to-business (B2B) VAT listings. Applicable for the eBay Germany (DE), Austria (AT), or Switzerland CH) site only. If false or not present, the category does not support this feature. GetCategories Conditionally ReturnAll If true, the category is associated with catalog content and the corresponding catalog is identified by the characteristics set ID. See CharacteristicsSets. As the Pre-filled Item Information feature uses the Item Specifics feature, the set of catalog-enabled categories is a subset of the categories that are mapped to characteristics sets. Not returned if false. GetCategory2CS Conditionally MappedCategoryArray Distinct numeric ID for a category on eBay. For GetPopularKeywords, -1 represents the root category. 10 AddItem GetItemRecommendations AddLiveAuctionItem VerifyAddItem Yes RelistItem ReviseItem ReviseLiveAuctionItem No GetBidderList Always PrimaryCategory GetBidderList Conditionally FreeAddedCategory SecondaryCategory GetCategories Always ReturnAll GetCategoryListings GetContextualKeywords GetPopularKeywords Always GetCategory2CS Always MappedCategoryArray GetCategory2CS Conditionally UnmappedCategoryArray GetItem Always PrimaryCategory none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItem Conditionally FreeAddedCategory SecondaryCategory none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions ReturnAll Always GetItemTransactions GetSellerTransactions Conditionally ReturnAll GetMyeBay GetSearchResults GetSuggestedCategories Conditionally GetOrderTransactions none Conditionally GetOrderTransactions none Conditionally GetSellerList Conditionally FreeAddedCategory SecondaryCategory ItemReturnDescription, ReturnAll GetSellerList Conditionally PrimaryCategory SecondaryCategory 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. Output only. For the GetSearchResults response, NumOfItems indicates the total quantity of matching items in a category. Matching categories at the same level (i.e., in sibling categories) are sorted by NumOfItems, descending order. GetCategories Always ReturnAll GetSearchResults Conditionally CategoryArray (out) Display (text) name of the category as displayed on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel). 30 (21 for China) GetCategories Always ReturnAll GetCategoryListings GetContextualKeywords Always GetBidderList Always PrimaryCategory GetBidderList Conditionally FreeAddedCategory SecondaryCategory GetItem Always PrimaryCategory none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItem Conditionally FreeAddedCategory SecondaryCategory none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetMyeBay GetSearchResults GetSuggestedCategories Conditionally CategoryArray GetSellerList Conditionally ItemReturnDescription, ReturnAll 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). For GetPopularKeywords, -1 represents the root category. 10 GetCategories Always ReturnAll GetSuggestedCategories Conditionally (out) Textual 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 Returned from GetCategory2CS calls with compatibility levels lower than 369. Supports listing with Pre-filled Item Information. Specifies the product finder ID associated with this category, if any. Only returns a value when ProductFinderAvailable is true. Output only. GetCategory2CS Obsolete Conditionally MappedCategoryArray (out) Returned from GetCategory2CS calls. Supports listing with Pre-filled Item Information. If the category supports single-attribute search, this field returns a value of true. Otherwise this field not returned or returned as false. GetCategory2CS Conditionally MappedCategoryArray (out) Returned from GetCategory2CS calls with compatibility levels lower than 369. Supports listing with Pre-filled Item Information. If the category supports a product finder-based search, this field returns a value of true. Otherwise this field returns null or false. Output only. GetCategory2CS Obsolete Conditionally MappedCategoryArray (out) Returned from GetCategory2CS calls with compatibility level 369 and higher. Supports listing with Pre-filled Item Information. Specifies the buy-side and/or sell-side product finder IDs associated with this category, if any. GetCategory2CS Conditionally MappedCategoryArray Returned from GetCategory2CS calls. A list of one or more characteristics sets mapped to the category. Use this information when working with Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) functionality. Output only. GetCategory2CS Conditionally MappedCategoryArray SiteWideCharacteristicSets (out) If true, indicates a category that has expired and to which items may not be listed. GetCategories Always ReturnAll 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. GetCategories Always ReturnAll 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). GetCategories Always ReturnAll If true, indicates the that category indicated in CategoryID is a virtual category, to which items may not be listed. GetCategories Always ReturnAll The total quantity of matching items in the category. In the GetSearchResults response, matching categories at the same level (i.e., sibling categories) are sorted by this value. That is, if the request specifies that fewer categories or subcategories should be returned, the ones with the most matching items are returned first. See the Developer's guide for more information. GetCategoryListings GetSearchResults Conditionally CategoryArray GetCategoryListings Conditionally CategoryArray Indicates whether this category is eligible for Motors Seller Guarantee program. This tag is emitted for eligible categories only on the eBay Motors site. GetCategories Conditionally ReturnAll Indicates whether the category 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. If ORPA is true, the category overrides (toggles or reverses) the site's ReservePriceAllowed setting. In other words: - If ReservePriceAllowed is true, reserve price is not allowed in this category. - If ReservePriceAllowed is false, reserve price is allowed in this category. If ORPA is not present (or false), there is no override. That is, the category's setting is the same as the site's ReservePriceAllowed setting. GetCategories Always ReturnAll Indicates whether the category 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. If ORRA is true, the category overrides (toggles or reverses) the site's ReduceReserveAllowed setting. In other words: - If ReduceReserveAllowed is true, reserve price reduction is not allowed in this category. - If ReduceReserveAllowed is false, reserve price reduction is allowed in this category. If ORRA is not present (false), there is no override. That is, the category's setting is the same as the site's ReduceReserveAllowed setting. GetCategories Conditionally ReturnAll Item.LotSize is not permitted when you list in this category. If true, indicates that lot sizes are disabled in the specified category. GetCategories Always ReturnAll (out) The list of keywords returned by GetPopularKeywords. GetPopularKeywords Always (in) A list of one or more characteristic set IDs. In GetProductSearchResults, these IDs indicate which characteristic sets to search in. If not specified, the search is conducted across all characteristic sets. Only applicable when QueryKeywords is specified. Numeric identifier for a characteristic set. Use GetCategory2CS to determine mappings between categories and characteristic sets that are catalog-enabled. GetProductSearchResults No 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 characteristics set. Applicable when working with Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) functionality. See the eBay Web Services guide for more information. Constant value that identifies the characteristic in a language-independent way. Unique within the characteristic set. GetProductFamilyMembers GetProductSearchPage GetProductSearchResults ReturnAll Always 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. GetProductSearchPage ReturnAll Conditionally SortCharacteristics GetProductFamilyMembers GetProductSearchResults Conditionally 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. GetProductFamilyMembers GetProductSearchPage GetProductSearchResults ReturnAll Always 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. GetProductSearchPage ReturnAll Conditionally SortCharacteristics GetProductFamilyMembers GetProductSearchResults Conditionally 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). GetProductFamilyMembers GetProductSearchPage GetProductSearchResults ReturnAll Always 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. GetProductSearchPage ReturnAll Conditionally SortCharacteristics List of one or more valid values for the characteristic. GetProductFamilyMembers GetProductSearchResults Always Indicates whether one attribute or multiple attributes can be used as the search criteria when calling GetProductSearchResults. (in/out) The search criteria can consist of one attribute. Applications should validate that only one searchable attribute is selected for the query. (in/out) The search criteria can consist of multiple attributes. One or more searchable attributes can be selected, and users should be informed that the search engine will apply "AND" logic to the query. (out) Reserved for internal or future use A level in the eBay category hierarchy at which a particular group of items can share a common set of attributes. A set of characteristics that can be used to describe similar kinds of items in a standardized way. The well-known name of the characteristic set (e.g., "Tickets" or "Books"). GetCategory2CS Conditionally MappedCategoryArray SiteWideCharacteristicSets 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 Conditionally MappedCategoryArray SiteWideCharacteristicSets GetProductFamilyMembers GetProductSearchPage GetProductSearchResults 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 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 ReturnAll Always 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 GetUser Conditionally GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Defines the affiliation status for a nonprofit charity organization registered with the dedicated eBay Giving Works provider. Contains information about a nonprofit charity organization. (out) A name assigned to a specified nonprofit organization. 150 GetCharities Conditionally (out) The stated mission of the nonprofit charity organization. This mission is displayed in the Giving Works item listing. 150 GetCharities Conditionally (out) A URL with the location of the nonprofit charity organization's logo image. Logo must be JPG or GIF format, with a size maximum of 50 KB. This image is displayed in the Giving Works item listing. GetCharities Conditionally (out) The status of the nonprofit charity organization. (out) Keyword string to be used for search purposes. (out) Region that the nonprofit charity organization is associated with. A specific nonprofit charity organization may be associated with only one region. Meaning of input values differs depending on the site. See GetCharities in the API Developer's Guide for the meaning of each input/output value. CharityRegion input value must be valid for that SiteID. GetCharities Conditionally (out) Domain (mission area) that a nonprofit charity organization belongs to. Nonprofit charity organizations may belong to multiple mission areas. Meaning of input values differs depending on the site. See GetCharities in the API Developer's Guide for the meaning of each input/output value. CharityDomain input value must be valid for that SiteID. GetCharities Conditionally (out) A unique identification number assigned by eBay to registered nonprofit charity organizations. This number is returned in GetCharitiesResponse as an id attribute in the parent Charity node. (out) A unique identification number assigned by eBay to registered nonprofit charity organizations. GetCharities Conditionally CharitySellerStatusCodeType - Type declaration to be used by other schema. Indicates the status of the seller's charity seller account. (in/out) The seller's charity seller account is suspended. (in/out) The seller is a registered charity seller. (in/out) The seller is no longer a registered charity seller. The account with the eBay Giving Works provider is closed. (in/out) The credit card associated with a seller's charity seller account has expired. (in/out) The token associated with a seller's charity seller account has expired. (in/out) The credit card associated with a seller's charity seller account will expire in 15 (or fewer) days. (in/out) The seller is a registered charity seller, but has no credit card associated with the charity seller account. (in/out) The seller is no longer a registered charity seller and has lost direct seller status. (in) The seller's direct debit card was rejected. (out) 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. Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider. 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. (out) The name of the benefiting nonprofit charity organization selected by the charity seller. 150 GetBidderList Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrderTransactions none Conditionally GetItem GetSellerList ItemReturnDescription, ReturnAll Conditionally (out) A unique identification number assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. Being superseded by CharityID. Max 10 digits. AddItem GetItemRecommendations RelistItem VerifyAddItem No GetBidderList Conditionally GetItem GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrderTransactions none Conditionally (in/out) The percentage of the purchase price that the seller donates to the selected nonprofit organization. This percentage is displayed in the Giving Works item listing. Possible values: 1.0 to 100.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 GetItemRecommendations RelistItem VerifyAddItem Conditionally GetBidderList Conditionally GetItem GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrderTransactions none Conditionally (in/out) A unique identification number assigned by eBay to registered nonprofit charity organizations. Required input when listing Giving Works items. AddItem GetItemRecommendations RelistItem VerifyAddItem Conditionally GetBidderList Conditionally GetItem GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrderTransactions none Conditionally (out) The stated mission of the nonprofit charity organization. This mission is displayed in the Giving Works item listing. 512 GetBidderList Conditionally GetItem GetSellerList ItemReturnDescription, ReturnAll Conditionally (out) The URL of the nonprofit charity organization. This URL is displayed in the Giving Works item listing. GetItem GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList Conditionally (out) The status of the nonprofit charity organization. GetBidderList Conditionally GetItem GetSellerList ItemReturnDescription, ReturnAll Conditionally (out) If true, indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item purchase price to a selected nonprofit organization. GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions none Conditionally The checkout method used by the buyer at external site. Other Checkout Method was used. Checkout is handled by a third party. (out) Reserved for internal or future use. CheckoutStatusCodeType - Type declaration to be used by other schema. Indicates the current state of the checkout process for a transaction. (in/out) Checkout complete. (in/out) Checkout incomplete--no details specified. (out) Buyer requests total from seller. (out) Seller responded to buyer's request. (out) Reserved for internal or future use. Indicates the success or failure of a buyer's online payment. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none The time the status was last modified. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none The payment method the buyer uses to purchase the item. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none The status of the order. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none Combined Purchase Options No Combined Purchase Yes Specify Discount Now Yes Specify Discount Later Reserved for internal or future use Combined Purchase Days (in/out) 3 Days (in/out) 5 Days (in/out) 7 Days (in/out) 14 Days (in/out) 30 Days Reserved for internal or future use Defines a seller's preferences for allowing buyers to combine more than one purchase into one payment. Contains a seller's preferences for having shipping costs calculated by eBay. GetUserPreferences Conditionally SetUserPreferences No Specifies whether or not a seller wants to allow buyers to combine purchases in order to receive a discount. GetUserPreferences Conditionally SetUserPreferences No Specifies the period in which the user will allow buyers to combine purchases in order to receive a discount. GetUserPreferences Conditionally SetUserPreferences No Specifies a seller's preferences for flat-rate shipping. GetUserPreferences Conditionally SetUserPreferences No CommentTypeCodeType - Type declaration to be used by other schema. These are the possible codes to specify the types of feedback/comment. Additional information about feedback is available in the online Help of the eBay site. (out) Positive feedback. Increases total feedback score. (out) Neutral feedback. No effect on total feedback score. (out) Negative feedback. Decreases total feedback score. (out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible. (out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party. (out) Reserved for internal or future use. Indicates whether the transaction process is complete, incomplete, or pending. (in/out) Transaction is incomplete. (in/out) Transaction is complete. (in/out) Transaction is pending. (out) Reserved for internal or future use Filter that retrieves only items with the specified item conditon. (in) Retrieve all items that match the query, regardless of condition. GetSearchResultsExpress No (in) Only retrieve items that are listed as new (or the equivalent). That is, do not retrieve used or refurbished items (or the equivalent). New is the default setting. (Items that waive the Item Condition requirement are also returned with this setting. If necessary, you can use GetCategoryFeatures to determine which categories waive the Item Condition requirement.) GetSearchResultsExpress No (out) Reserved for internal or future use. Score and rank for a keyword identified for a web page. (out) The keyword. 64 GetContextualKeywords Always (out) The eBay category in which the keyword is used. GetContextualKeywords Always (out) The relevance of this keyword and category to the web page. 0 1 GetContextualKeywords Always (out) The ranking of this keyword and category relative to other keywords and categories (when scores are sorted). 1 2147483647 GetContextualKeywords Always CountryCodeType - Type declaration to be used by other schema. This code list module defines the enumerated types of standard 2-letter ISO 3166 country codes. This code list also contains some additional country codes not defined in the ISO 3166 country code set, which appear at the end of this code list and are noted as non-ISO. Country codes may be used as input and as output. For more information on ISO 3166 country codes, see the ISO site: http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html Details about a specific country. Two-letter country abbreviation. Related fields: Item.Country in AddItem SearchLocationFilter.CountryCode in GetSearchResults GeteBayDetails Conditionally Full country name for display purposes. May be similar to (but not necessarily identical to) CountryName in addresses (e.g., User.RegistrationAddress.CountryName in GetUser). GeteBayDetails Conditionally Contains preferences describing how items similar to the one the user is presently viewing are promoted. (For eBay store owners only) Specifies whether cross-promotions are enabled for the seller's listings. GetUserPreferences Conditionally SetUserPreferences No (For eBay store owners only) Specifies which items should be shown in cross-sell promotions (such as Buy It Now or Store Inventory items) and in which sequence. GetUserPreferences Conditionally SetUserPreferences No (For eBay store owners only) Specifies whether to display only items with gallery images and whether they should precede other items in cross-sell promotions. GetUserPreferences Conditionally SetUserPreferences No (For eBay store owners only) Specifies how to sort items displayed in a cross-sell promotion. GetUserPreferences Conditionally SetUserPreferences No (For eBay store owners only) Specifies which items (such as Buy It Now or Store Inventory items) should be shown in upsell promotions and in which sequence. GetUserPreferences Conditionally SetUserPreferences No (For eBay store owners only) Specifies whether to display only items with gallery images in upsell promotions and whether they should precede other items. GetUserPreferences Conditionally SetUserPreferences No (For eBay store owners only) Specifies how to sort items used in an upsell promotion. GetUserPreferences Conditionally SetUserPreferences No (out) Contains one or more items cross-promoted with the display or purchase of a referring item. (out) 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 Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCrossPromotions Always (out) The primary cross-promotion rule scheme that was applied to return the cross-promoted item. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCrossPromotions Always (out) The type of promotion, CrossSell or UpSell. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCrossPromotions Always (out) The eBay user ID of the seller offering the cross-promoted item. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCrossPromotions Always (out) Whether a shipping discount is offered by the seller when the cross-promoted item is purchased. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCrossPromotions Always (out) The key of the seller who is promoting the item. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCrossPromotions Conditionally (out) The store name of the seller offering the cross-promoted item. GetCrossPromotions GetItem Conditionally (out) Contains one cross-promoted item. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCrossPromotions Conditionally This code list module defines the enumerated types of standard 3-letter ISO 4217 currency codes. Currency codes can be used as input or output (in/out); however, only certain currency codes are currently valid for use on eBay. The valid codes are documented below with the notation "(in/out)". Other codes in this list are for future use. A reference: http://www.xe.com/iso4217.htm (in/out) Indian Rupee. For eBay, you can only specify this currency for listings you submit to the India site (site ID 203). (in/out) Canadian Dollar. For eBay, you can only specify this currency for listings you submit to the Canada site (site ID 2) (Items listed on the Canada site can also specify USD.) (in/out) Chinese Yuan Renminbi. For eBay, you can only specify this currency for listings you submit to the China site (site ID 223). (in/out) Hong Kong Dollar. For eBay, you can only specify this currency for listings you submit to the Hong Kong site (site ID 201). (in/out) Australian Dollar. For eBay, you can only specify this currency for listings you submit to the Australia site (site ID 15). (in/out) Swiss Franc. For eBay, you can only specify this currency for listings you submit to the Switzerland site (site ID 193). (in/out) Malaysian Ringgit. For eBay, you can only specify this currency for listings you submit to the Malaysia site (site ID 207). (in/out) Euro. For eBay, you can only specify this currency for listings you submit to these sites: Austria (site 16), Belgium_French (site 23), France (site 71), Germany (site 77), Italy (site 101), Belgium_Dutch (site 123), Netherlands (site 146), Spain (site 186), Ireland (site 205). (in/out) Philippines Peso. For eBay, you can only specify this currency for listings you submit to the Philippines site (site ID 211). (in/out) Poland, Zloty. For eBay, you can only specify this currency for listings you submit to the Poland site (site ID 212). (in/out) US Dollar. For eBay, you can only specify this currency for listings you submit to the US (site ID 0), eBayMotors (site 100), and Canada (site 2) sites. (in/out) Singapore Dollar. For eBay, you can only specify this currency for listings you submit to the Singapore site (site 216). (in/out) Swedish Krona. For eBay, you can only specify this currency for listings you submit to the Sweden site (site 218). (in/out) New Taiwan Dollar. For eBay, you can only specify this currency for listings you submit to the Taiwan site (site 196). (in/out) Pound Sterling. For eBay, you can only specify this currency for listings you submit to the UK site (site ID 3). Reserved for internal or future use. Details about a currency. Currency abbreviation. Related fields: Item.Currency and Item.StartPrice in AddItem SearchLocationFilter.Currency in GetSearchResults GeteBayDetails Conditionally Full currency name for display purposes. GeteBayDetails Conditionally Container for a set of data elements (see below) that are applicable for a set of products that were returned within the same response. The data elements contain supplemental information that can help end users understand product search results. Usage of this information is optional and may require developers to inspect the information to determine how it can be applied in an application. Output only. An HTML snippet that specifies hints for the user, help links, help graphics, and other supplemental information that varies per characteristic set. In GetProductSearchPage, one DataElement value contains a hint (including an empty HTML achor element), one DataElement value may contain a URL to insert into the HTML anchor as the href value, and one DataElement value may contain a URL that eBay uses as a help graphic. If no value is available in the meta-data, a dash ("--") is returned instead. Usage of this information is optional and may require developers to inspect the information to determine how it can be applied in an application. Because this is returned as a string, the HTML markup elements are escaped with character entity references (e.g.,<a href=""><Attributes>...). See the appendices in the eBay Web Services guide for general information about string data types. GetProductSearchPage ReturnAll Always Identifier for a data element. This is primarily for internal use by eBay. Developers can choose to inspect this information and determine how it can be applied in their applications. GetProductSearchPage ReturnAll Always Matches the AttributeSetID associated with a response returned from the same call that returned the data element set. As calls like GetProductSearchResults can perform batch searches, this ID helps you determine which attribute set the data element set is associated with. GetProductFamilyMembers GetProductSearchPage GetProductSearchResults ReturnAll Always Specifies a subcomponent of a date. Useful in cases when it is helpful to allow separate text fields or drop-down lists to be rendered for each date subcomponent. (For example, when calling GetProductSearchResults, you use date specifiers to indicate the date subcomponent that the attribute represents.) (in/out) The month subcomponent of a date. (in/out) The day subcomponent of a date. (in/out) The year subcomponent of a date. (out) Reserved for internal or future use. DepositTypeCodeType - Type declaration to be used by other schema. 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). If the item listed is not a US eBay Motors item, the DepositType value is returned as "None". (in/out) No deposit needed (in/out) Pay the deposit using one of the specified PaymentMethods (BuyerPaymentMethodCodeType) (in/out) No longer in use (defaults to OtherMethod) (out) Reserved for internal or future use The template details establish how pictures are to be positioned relative to the description text. The template determines which eBay-provided theme (e.g. Valentine's Day) is to be applied for presenting pictures and description text. Reserved for future use. The information for one Theme or one Layout. Unique identifier for the group in which a Theme falls (holidays, special events, etc.). Not returned for Layouts. GetDescriptionTemplates Always Unique identifier for one Theme or Layout. GetDescriptionTemplates Always URL for a small (100x120 pixel) image providing a sample of how a Theme or Layout looks. GetDescriptionTemplates Always Unique text name of the Theme or Layout. GetDescriptionTemplates Always XML defining the template. Elements you must include in your XML: ThemeTop, ThemeUserCellTop, ThemeUserContent, ThemeUserCellBottom, ThemeBottom. Not returned for Layouts. GetDescriptionTemplates Always Either Layout or Theme. GetDescriptionTemplates Always A designation of what kind of information you wish returned by GeteBayDetails for the specified eBay site. Details about a specific country. GeteBayDetails Conditionally Details about a specific currency. GeteBayDetails Conditionally Details about a specific payment option. GeteBayDetails Conditionally Details about a specific geographical area. GeteBayDetails Conditionally Details about a specific location or region to which the seller is willing to ship. GeteBayDetails Conditionally Details about a specific shipping service. GeteBayDetails Conditionally Details about a specific eBay site. GeteBayDetails Conditionally Details about a specific tax jurisdiction or region. GeteBayDetails Conditionally Details about a specific eBay URL. GeteBayDetails Conditionally Reserved for future use. Details about a specific maximum dispatch time. GeteBayDetails Conditionally The means of receipt of notification. Typical API, web page interaction. SetNotificationPreferences No GetNotificationPreferences Conditionally For SMS/wireless application. SetNotificationPreferences No GetNotificationPreferences Conditionally CN (out) Reserved for internal or future use. File type, operating system specifications, or other requirements for using the digital item. In this section, specify the following information about your digital item, if applicable: - Type of file (file format). Examples include MP3, MOV, etc. - Any computer hardware or software requirements. For example, is your file compatible with both PCs and Macintosh computers? Will it work with all operating systems (Windows XP, Windows 2000, Mac OS X, etc.)? Does the buyer need a specific software program, such as Microsoft Word, to use the item? - Any other requirements. For example, does the buyer need to provide an email address where you will send the item? For example: "Adobe PDF (Portable Document Format) file; buyer will need Adobe Acrobat Reader 5.0 or higher and 5MB of available hard-disk space." Be as specific as possible so that buyers know exactly what they need to access and use the item successfully. This information will appear in your listing so that buyers can make an informed purchase decision. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetSellerList Conditionally ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none GetBidderList GetCategoryListings GetItem GetSearchResults Conditionally The digital download method. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetSellerList Conditionally ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none GetBidderList GetCategoryListings GetItem GetSearchResults Conditionally The download URL for the digital item. Provide a Web address for your digital item that uses one of the following protocols: HTTP, HTTPS, or FTP. If you do not have a Web address that meets these criteria, specify alternate delivery information in the Instructions field instead. The information will be displayed to the buyer only after payment has been confirmed. Required if Method value is DownloadURL. Ignored if Method value is AlternateDeliveryInstructions (or None). AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none GetBidderList GetItem Conditionally Text instructions for accessing the digital item. For example, if no delivery URL is provided, the seller may ask the buyer to specify an email address when they pay for the item so that the seller can send the file to the buyer. If a Web address is specified in URL, the seller may provide instructions on using the Web address. The text will be displayed as is (so do not pass in HTML or Javascript). The information will be displayed to the buyer only after payment has been confirmed. Required if Method value is AlternateDeliveryInstructions. Optional if Method value is DownloadURL and a DownloadURL value is specified. Ignored if Method value is None. 500 (characters) AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetOrderTransactions Conditionally none GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItem Conditionally The digital delivery listing option is disabled for this category. GetCategoryFeatures ReturnAll Conditionally The digital delivery listing option is available in this category. GetCategoryFeatures ReturnAll Conditionally The digital delivery listing option is available in this category, and eBay normally displays this option by default in this category. GetCategoryFeatures ReturnAll Conditionally If the field is present, the digital delivery feature applies to the category. If applicable, the field is returned as an empty element (i.e., a boolean value is not returned). The item cannot be downloaded. AddItem RelistItem ReviseItem VerifyAddItem No The item can be downloaded by using a URL. AddItem RelistItem ReviseItem VerifyAddItem No The item can be downloaded according to instructions specified by the seller. AddItem RelistItem ReviseItem VerifyAddItem No Details about a specific maximum dispatch time, the maximum number of business days required to ship an item to domestic buyers after receiving a cleared payment. Integer value (1, 2, 3, 4, 5, 10, 15, or 20) corresponding to the maximum dispatch time. Related field: Item.DispatchTimeMax in AddItem GeteBayDetails Conditionally Value and unit (e.g., 10 Days) for the maximum dispatch time. Useful for display purposes. GeteBayDetails Conditionally Ways to Display PayNow Button Show PayNow Button For All Payment Methods Show PayNow Button For PayPal Only Reserved for internal or future use Represents a list of disputes. Can hold zero or more Dispute types, each of which describes a dispute. The information that describes a dispute, including the buyer's name, the transaction ID, the dispute state and status, whether the dispute is resolved, and any messages posted to the dispute. GetUserDisputes Always ReturnSummary, ReturnAll, none Contains all information describing a dispute. The unique identifier of a dispute, returned by the eBay site when the dispute is created. GetDispute Always GetUserDisputes Conditionally ReturnSummary, ReturnAll, none The type of dispute. GetDispute Always GetUserDisputes Conditionally ReturnSummary, ReturnAll, none The internal state of the dispute. The value determines which values of DisputeActivity are valid when responding to a dispute. GetDispute Always GetUserDisputes Conditionally ReturnSummary, ReturnAll, none The status of the dispute, which provides additional information about the dispute state. GetDispute Always GetUserDisputes Conditionally ReturnSummary, ReturnAll, none The role of the person involved in the dispute who is not taking action or requesting information. The role is either Buyer or Seller. GetUserDisputes Conditionally ReturnSummary, ReturnAll, none The user name of the person involved in the dispute who is not taking action or requesting information. The role is either Buyer or Seller. GetUserDisputes Conditionally ReturnSummary, ReturnAll, none The role of the person involved in the dispute who is taking action or requesting information. The role is either Buyer or Seller. GetUserDisputes Conditionally ReturnSummary, ReturnAll, none The eBay user ID of the buyer involved in the dispute. GetDispute Always The eBay user ID of the seller involved in the dispute. GetDispute Always The unique identifier of the transaction under dispute. The transaction is created when the winning bidder commits to purchasing the item but before the bidder pays. 10 GetDispute Always GetUserDisputes Conditionally ReturnSummary, ReturnAll, none Information about the item that spawned the transaction. The transaction is a purchase from this item's listing. GetDispute Always GetUserDisputes Conditionally ReturnSummary, ReturnAll, none The top-level reason for the dispute. The value of DisputeReason determines which values of DisputeExplanation are valid. See DisputeExplanationCodeList for details. GetDispute Always GetUserDisputes Conditionally ReturnSummary, ReturnAll, none The detailed explanation for the dispute. Valid values depend on the value of DisputeReason. See DisputeExplanationCodeList for details. GetDispute Always GetUserDisputes Conditionally ReturnSummary, ReturnAll, none Whether the dispute is currently eligible for Final Value Fee credit. The value is usually Ineligible until 7 days after the dispute was created, unless a fee exception applies. GetDispute Always GetUserDisputes Conditionally ReturnSummary, ReturnAll, none The date and time the dispute was created, in GMT. GetDispute Always GetUserDisputes Conditionally ReturnSummary, ReturnAll, none The date and time the dispute was modified, in GMT. GetDispute Always GetUserDisputes Conditionally ReturnSummary, ReturnAll, none The action resulting from the dispute resolution. The action might include a Final Value Fee credit to the seller, a strike to the buyer, a reversal, or an appeal. GetUserDisputes Conditionally ReturnAll, none A response or message posted to a dispute, either by an application or by a user on the eBay site. GetDispute Always GetUserDisputes Conditionally ReturnAll, none Whether the buyer can close a dispute unhappy and escalate it to the eBay Standard Purchase Protection Program. To escalate, the buyer must be eligible for the PPP. Used in Item Not Received disputes. GetDispute Always Whether the buyer is eligible for the eBay Standard Purchase Protection Program. The eligibility rules are described in the eBay site online help. Used in Item Not Received disputes. GetDispute Always DistanceType used in proximity search The measurement used in a proximity search distance calculation. GetCategoryListings GetSearchResults Conditionally The unit used in a proximity search distance calculation. GetCategoryListings GetSearchResults Conditionally Container for a list of Express departments, aisles, and/or products. Can contain zero, one, or multiple ExpressHistogramDepartmentType objects. Contains item and product counts for a department, aisles, and/or Express product types. Only returned when HistogramDetails is configured to retrieve histogram data. Multiple Department nodes can be returned. GetSearchResultsExpress Conditionally Defines the DutchBINEnabled feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Allowed categories are Motorcycles, Powersports, and Other Vehicles. In addition to the categories allowed by LocalMarketSpecialty, allows Passenger Vehicles. Allows same categories as LocalMarketRegular. The status of a particular entry. (in/out) The entry is enabled. (in/out) The entry is disabled. (out) Reserved for future use. Contains the seller's preferences for the end of auction (EOA) email to the buyer. The text of the custom message for the end of auction (for auctions) or end of transaction (for Buy It Now) emails. GetUserPreferences Conditionally SetUserPreferences No The URL of the logo to include in the customized email. GetUserPreferences Conditionally SetUserPreferences No The type of logo to include in the customized email. GetUserPreferences Conditionally SetUserPreferences No Indicates whether or not the seller wishes to send a customized email to winning buyers. GetUserPreferences Conditionally SetUserPreferences No Indicates whether or not the text of the customized message will be customized. GetUserPreferences Conditionally SetUserPreferences No Indicates whether or not the seller wishes to include a logo in the customized email. GetUserPreferences Conditionally SetUserPreferences No Indicates whether or not the seller wishes to receive a copy of the customized email sent to the winning buyer. GetUserPreferences Conditionally SetUserPreferences No EndOfAuctionLogoTypeCodeType - Type declaration to be used by other schema. Indicatest the type of logo to be used in a customize end of auction (EOA) email. The PayPal Winning Bidder Notice logo. The eBay Store logo. A customized logo specified in LogoURL. Reserved for internal or future use. (out) Indicates that no logo has been specified for use in the end of auction (EOA) email. ReasonCodeType - Type declaration to be used by other schema. Specifies the seller's reason for ending an item listing early. This is required if the seller ended the listing early and the item did not successfully sell. (in) The item was lost or broken. EndItem Conditionally (in) The item is no longer available for sale. EndItem Conditionally (in) The minimum bid or reserve price is incorrect. EndItem Conditionally (in) The listing contained an error (other than minimum bid or reserve price). EndItem Conditionally (out) Reserved for internal or future use. EscrowCodeType - Type declaration to be used by other schema. Indicates whether escrow is used for a listing. (in/out) By Buyer (in/out) By Seller (in/out) None (out) Reserved for internal or future use Container for items returned with an expanded search. Item that is the result of an expanded search. If, in a GetSearchResults request, you specify true for ExpandSearch, the search is expanded when a small result set is returned. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, then the search results are expanded. Specifically, the search returns items (if there are matches) in one or more of the following containers: InternationalExpansionArray (for items available from international sellers), FilterRemovedExpansionArray (items that would be returned if filters such as PriceRangeFilter are removed), and AllCategoriesExpansionArray (for items available if category filters are removed). The maximum number of items returned in each container is 6 to 10. GetSearchResults Conditionally The number of matching items available under the expansion. GetSearchResults Conditionally For the US and Germany sites, an eBay item must meet a number of eligibility requirements in order to also be included on eBay Express. One requirement is that the item must include the Item Condition attribute (using Item Specifics). Some categories may waive this requirement. Currently, this type defines no special meta-data. (An empty element is returned.) For GetSearchResultsExpress, controls the details to retrieve per item, product, or histogram. (in) The effect of Coarse varies for HistogramDetails, ProductDetails, and ItemDetails. For HistogramDetails, this is primarily useful for reducing the histogram depth when you search across all departments or within a specific department. (When you search by AisleName or ProductTypeName, there is no difference between Coarse and Fine). If the request includes no DepartmentName, AisleName, or ProductName, retrieve a histogram for all departments that match the criteria in the request, but don't retrieve aisle or product type details. Stand-alone domains (aisles and product types) aren't grouped into departments, so Express ignores them in this departments-only histogram. That is, the data in the histogram is only based on matching departments and their grouped subdomains. (Please note the following consequences of retrieving a departments-only histogram: If Express only finds items or products in stand-alone domains, then ItemCount or ProductCount could be 0. For example, if Express finds catalog products in two departments, but only finds items in a stand-alone product type (like DVDs & Movies), ItemCount would be 0 in the two departments. Furthermore, if all matching items and catalog products are in stand-alone domains, no histogram is returned at all (because there are no matching departments). This might occur when you also add filters (e.g., LowestPrice) or more query keywords to your request.) If the request only specifies DepartmentName, retrieve a histogram for that department and all of its aisles (but no histogram details for any product types it contains). If the request only specifies AisleName, retrieve the full histogram for that aisle, including all of its product types and the parent department. If the request only specifies ProductTypeName, retrieve the histogram for its parent department (and any aisles), or only retrieve the histogram for the product type if isn't grouped into a department. For ProductDetails, retrieve the Title, MinPrice, and MaxPrice fields for each product found. For ItemDetails, retrieve the ItemID, Title, BuyItNowPrice, and ShippingDetails node for each item found. GetSearchResultsExpress No (in) For HistogramDetails, retrieve a full histogram (all levels of the domain hierarchy) that matches the request. If you specify Fine, you must also specify DepartmentName, AisleName, and/or ProductTypeName in the request. If the request only specifies DepartmentName, retrieve a full histogram for that department, all of its aisles, and all of its product types. If the request only specifies AisleName or ProductTypeName, the results are the same as specifying Coarse. For ProductDetails, retrieve all applicable fields for each catalog product found. For ItemDetails, retrieve all applicable fields for each item found. GetSearchResultsExpress No (in) For HistogramDetails, omits the histogram from the response. For ProductDetails, omits the ProductArray from the response. For ItemDetails, omits the ItemArray from the response. GetSearchResultsExpress No (out) Reserved for internal or future use. Item details that are only applicable to listings on Express (not the main eBay site). Large gallery image that appears in the "Grid View" in search results on the Express site. The longest dimenstion is 140 pixels. Only returned when ItemDetails is set to Fine. Express generates the image based on pictures that the seller includes in the listing. For details about Express listing criteria, see the "eBay Express" section of the eBay Web Services Guide. If the item was listed in an eBay category that does not require pictures for Express (like Tickets), a generic image may be returned instead. GetSearchResultsExpress Conditionally Small gallery image that appears in the "List View" in search results on the Express site. The longest dimenstion is 96 pixels. Only returned when ItemDetails is set to Fine. GetSearchResultsExpress Conditionally The item condition, if any. On Express US, this is often a value like "New", "Used", or "Refurbished", but the exact value can vary based on the Item Condition data that the seller used in the listing. For example, in some eBay categories, the condition can have a value like "New: With Tags" instead. (At the time of this writing, GetSearchResultsExpress mapped all conditions to "New" and "Used". However, this could change in the future.) By default, only new items (or the equivalent) are returned from GetSearchResultsExpress. Use Condition in the request to include used and refurbished items (or the equivalent) as well. Only returned when ItemDetails is set to Fine. Not applicable to calls that browse or search items on the main eBay site. GetSearchResultsExpress Conditionally For the US and Germany sites, an eBay item must meet a number of eligibility requirements in order to also be included on eBay Express. One requirement is that the category needs to support Express. Currently, this type defines no special meta-data. (An empty element is returned.) Details about an Express aisle and matching item and catalog product counts in that aisle, if any. Identifies the aisle and provides matching item and eBay catalog product counts in the specified aisle, if any. Only returned if an aisle matched the request. If this node is missing but Aisle.ProductType is present, it means that the product type specified in Aisle.ProductType is not grouped into an aisle. In the Express Web site UI, such product types are elevated to (treated as) aisles from the user's perspective (or as Departments, if Department.DomainDetails is also missing). However, the API always maintains the Department/Aisle/ProductType structure to help you distinguish between actual departments, aisles, and stand-alone product types. GetSearchResultsExpress Conditionally Contains item and catalog product counts for an Express product type. Only returned when HistogramDetails is configured to return product types. An Aisle node can contain multiple ProductType nodes. GetSearchResultsExpress Conditionally Details about an Express department and matching item and catalog product counts in that department, if any. Identifies the department and provides matching item and eBay catalog product counts in the specified department. Only returned if a department matched the request. If this node is missing but Department.Aisle.ProductType is present, it means that the product type specified in Department.Aisle.ProductType is not grouped into a department. In the Express Web site UI, stand-alone product types are elevated to (treated as) departments from the user's perspective. However, the API always maintains the Department/Aisle/ProductType structure to help you distinguish between actual departments, aisles, and stand-alone product types. GetSearchResultsExpress Conditionally Contains item and catalog product counts for an aisle (if any) and may contain a list of product types. Only returned when HistogramDetails is configured to return aisles and/or product types. A Department node can contain multiple Aisle nodes. GetSearchResultsExpress Conditionally Identifies a domain and provides statistics for items and catalog products found in that domain. The domain name, with no spaces. Use this to determine DepartmentName, AisleName, and/or ProductTypeName values to pass in the request. Note: The potential max length will be documented in a future release. GetSearchResultsExpress Conditionally The fully qualified display name of the domain, as it would appear in the Express Web site user interface. For example, a fully qualified aisle breadcrumb would include the department's display name and the aisle's display name. The names can contain spaces, and a greater-than character (">") is used as the delimiter; for example: Consumer Electronics > Cell Phones & PDAs > PDA Accessories. As with all string data types, reserved characters like ">" are escaped in the raw response. Note: The potential max length will be documented in a future release. GetSearchResultsExpress Conditionally The number of matching items that were found in the specified department, aisle, or product type. If HistogramDetails==Coarse and you don't specify DepartmentName, AisleName, or ProductTypeName in the request, Express only counts items found in matching departments. In this particular case, ItemCount could be 0 in all domain histogram results when the only matching items are in stand-alone product types or aisles (because they aren't grouped into departments). GetSearchResultsExpress Conditionally The number of matching eBay catalog products that were found in the specified department, aisle, or product type. If HistogramDetails==Coarse and you don't specify DepartmentName, AisleName, or ProductTypeName in the request, Express only counts catalog products found in matching departments. In this particular case, ProductCount could be 0 in all domain histogram results when the only matching catalog products are in stand-alone product types or aisles (because they aren't grouped into departments). GetSearchResultsExpress Conditionally The image associated with the department, aisle, or product, if any. All domains should be associated with an image. However, there may be rare cases when an image is not available. GetSearchResultsExpress Conditionally Details about an Express product type and matching item and catalog product counts in that product type, if any. Identifies an Express product type and provides item and eBay catalog product counts in that product type. Only returned if a product type matched the request. A product type domain can stand alone, or it can be grouped with other product types into an aisle or a department. GetSearchResultsExpress Conditionally Sort options for the Express histogram. (in) Sort the domains in the histogram by the item count in descending order. The domain with the most matching items is returned first. This is the default setting. GetSearchResultsExpress No (in) Sort the domains by the product count in descending order. The domain with the most matching products is returned first. GetSearchResultsExpress No (in) Sort the domains alphabetically by DomainDetails.Name. Domains at the same depth are sorted first. Within each domain, child domains are also sorted. For example, a "Books_Dept" department and its aisles or product types would be returned before a stand-alone "Hard_Domain_Music" product type. And that "Hard_Domain_Music" product type would be returned before a stand-alone "OldNavyAisle" aisle and its product types. GetSearchResultsExpress No (out) Reserved for internal or future use. Sorts the items in the ItemArray. (in) Sort the items by the lowest total cost, including shipping. The item with the lowest total cost is returned first. To calculate the total cost, PostalCode must also be specified in the request. GetSearchResultsExpress No (in) Sort the items by the highest total cost, including shipping. The item with the highest total cost is returned first. To calculate the total cost, PostalCode must also be specified in the request. GetSearchResultsExpress No (in) Sort the items by relevance. This is the default. The item with the highest relevance is returned first. The relevance is determined by various factors, such as matching item details and historical buyer behavior. GetSearchResultsExpress No (out) Reserved for internal or future use. For the US and Germany sites, an eBay item must meet a number of eligibility requirements in order to also be included on eBay Express. One requirement is that the item must include a picture (or gallery image). Currently, this type defines no special meta-data. (An empty element is returned.) Contains a seller's preferences related to listing items on Express. Specifies the kinds of eligible listings the seller wants to include on Express. Some values are only applicable to certain sites. Only applicable to sellers who are eligible to list on Express. For the US site, if the seller opts out of Express, their listings are immediately removed from Express. (Please note that other changes that affect a user or item's eligibility can take up to 7 days to be reflected.) GetUserPreferences Conditionally SetUserPreferences No omitted Coming soon: For eBay Germany users only. The PayPal account (email address) to use for eBay Express payments during checkout. If the first item in an order doesn't specify a PayPal account, Express Germany uses this default PayPal account for the item. (The account specified for the first item is used for all items in the same order.) This default account is only used for Express payments during checkout; it has no effect on item data. (To specify a default PayPal account for items, use the PayPal fields in the SellerPaymentPreferences node.) Only applicable to sellers who are qualified to list on Express Germany. Call GetUser to determine the seller's Express eligibility. When you set this value using SetUserPreferences, eBay validates that the PayPal account qualifies for Express. We check that the account is in good standing, it is a Business or Premier account, and it does not block unconfirmed addresses. This means the seller needs to configure their PayPal account correctly before calling SetUserPreferences. Note: If the PayPal account becomes ineligible later (e.g., the seller blocks unconfirmed addresses), GetUserPreferences still returns the specified email address. Therefore, the existence of this preference in GetUserPreferences does not guarantee that the specified address is valid for Express. When a PayPal account becomes ineligible, Express reevaluates the eligibility of the seller and their items, and may remove the seller's items from Express. See the eBay Web Services guide links below for more information. This preference does not control the seller's eligibility for Express. However, it can control an item's eligibility in some cases. That is, for a fixed-price or Store Inventory item to be eligible for Express Germany, either the item or this Express preference must specify a valid PayPal email address. (For other eligibility requirements, see the eBay Web Services guide.) In GetUserPreferences, this preference is only returned if a default PayPal account has been specified. eBay Express http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=eBayExpress Listing Criteria for eBay Express http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressListingCriteria (AddItem) Item.PayPalEmailAddress io_AddItem.html#Request.Item.PayPalEmailAddress GetUserPreferences Conditionally SellerPaymentPreferences node #Response.SellerPaymentPreferences SetUserPreferences No omitted SellerPaymentPreferences node #Request.SellerPaymentPreferences Sorts the products in ProductArray. (in) Sort the products by the lowest current price of the items available. The product with the lowest-priced item is returned first. GetSearchResultsExpress No (in) Sort the products by the highest current price of the items available. The product with the highest-priced item is returned first. GetSearchResultsExpress No (in) Sort the products by sales rank. The product with the highest sales rank (i.e., the best-selling product) is returned first. The rules that are used to determine the sales rank vary for each product type and are not disclosed in this documentation. However, in general, the sales rank is based on the number of items sold on Express and/or the main eBay site. This is the default. GetSearchResultsExpress No (out) Reserved for internal or future use. Information that eBay Express collects about an eBay catalog product. The title of the eBay catalog product. Always returned when Product is returned. GetSearchResultsExpress Always Lowest current price of active and ended listings on the specified eBay site that were pre-filled based on the eBay catalog product. The value is in the Express site's currency (i.e., the price is not converted). Round numbers might only show one zero after the decimal (e.g., 15.0). Always returned when Product is returned. GetSearchResultsExpress Always Highest current price of active and ended listings on the specified eBay site that were pre-filled based on this product. The value is in the Express site's currency (i.e., the price is not converted). Round numbers might only show one zero after the decimal (e.g., 15.0). Always returned when Product is returned. GetSearchResultsExpress Always Fully qualified URL for a stock image (if any) that is associated with the eBay catalog product. Only returned when ProductDetails is set to Fine. GetSearchResultsExpress Conditionally Total number of active listings (on the specified Express site) that were pre-filled based on this eBay catalog product. Only returned when ProductDetails is set to Fine. GetSearchResultsExpress Always An ISBN or UPC value (if any) that is associated with this eBay catalog product. Only returned when ProductDetails is set to Fine. GetSearchResultsExpress Conditionally The Express reference ID for an eBay catalog product (if any) that was used to pre-fill the listing's Item Specifics and other details. Only returned when ProductDetails is set to Fine. Note: This value is not the same as the ProductID used in AddItem and related calls. You cannot use this call or the catalog search calls to determine a relationship between this reference ID and the eBay catalog ProductID that is used for listing on eBay. GetSearchResultsExpress Conditionally A list of attribute and value pairs that are included in the product's pre-filled Item Specifics and that are applicable in Express search results. This does not necessarily include all Item Specifics that are defined for the product in the catalog. Typically, it returns only the top attributes (as determined by Express). See ExternalProductID for the ISBN or UPC, if applicable. Only returned when ProductDetails is set to Fine. GetSearchResultsExpress Conditionally Specifies the kinds of eligible listings tht the seller prefers to include on Express. (in/out) The seller wants all of their eligible listings to appear on Express (in addition to the main eBay site), regardless of the listing format. Only applicable to sellers who are eligible for Express US or Express Germany. (By default, eBay sets this option for every eligible seller.) (in/out) The seller only wants their Express format listings to appear on Express. (They don't want their fixed-price and Store Inventory format listings to appear on Express.) Only applicable to sellers who are eligible for Express Germany. (in/out) The seller does not want any of their eligible listings to appear on Express. That is, the seller prefers to completely opt out of Express. Only applicable to sellers who are eligible for Express US. (Germany sellers can't use the API to opt out of Express. Germany sellers should see the Express Web site online help for information on how to end their Express qualification.) (out) Reserved for internal or future use. A product finder ID. GetCategory2CS always (and only) returns this when Category.ProductFinderIDs is returned. GetCategory2CS Conditionally MappedCategoryArray (out) If true, the product finder can be used as input to GetSearchResults to search for listings with Item Specifics on the eBay site. 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 Conditionally MappedCategoryArray As input, only applicable for AddItem, VerifyAddItem, and GetSearchResults requests that include the ExternalProductID property. Indicates the type of ID being used to identify a stock product. Used when listing or searching for an item with Pre-filled Item Information in certain categories. Certain values are also returned from GetSellerPayments for Half.com listings only. See the Developer's Guide for applicable categories. (in/out) ExternalProductID.Value contains an ISBN value. In listing calls, required when you pass an ISBN as the external product ID. (This value is also applicable to Half.com listings.) AddItem GetSearchResults GetSearchResultsExpress VerifyAddItem Conditionally GetSellerPayments Conditionally (in/out) ExternalProductID.Value contains a UPC value. For AddItem and VerifyAddItem, required when you pass a UPC as the external product ID. (This value is also applicable to Half.com listings.) AddItem GetSearchResults GetSearchResultsExpress VerifyAddItem Conditionally GetSellerPayments Conditionally (in) ExternalProductID.Value contains an eBay catalog product ID. For AddItem and VerifyAddItem, required when you pass an eBay product ID as the external product ID. Not applicable with GetSearchResults or GetSearchResultsExpress. AddItem VerifyAddItem Conditionally (in) ExternalProductID.Value contains an EAN value. For AddItem and VerifyAddItem, required when you pass an EAN as the external product ID. Not applicable with GetSearchResults or GetSearchResultsExpress. AddItem VerifyAddItem Conditionally GetSellerPayments Conditionally (in) ExternalProductID.Value contains a set of keywords that uniquely identify the product. Only applicable to event ticket listings. See the eBay Web Services guide for information about using ticket keywords as an external product ID. For AddItem and VerifyAddItem, required when you pass a set of keywords as the external product ID. Not applicable with GetSearchResults or GetSearchResultsExpress. AddItem VerifyAddItem Conditionally (out) Reserved for internal or future use Contains an ISBN value, EAN value, UPC value, ticket keywords, or eBay catalog product ID, plus other meta-data. For event tickets, this type can contain a set of keywords that uniquely identify the product. Only applicable for certain categories that support Pre-filled Item Information. For items listed to eBay.com, either ExternalProductID or Item.ProductListingDetails can be specified in listing use cases (AddItem or GetItemRecommendations), but do not specify both in the same requst. Either ExternalProductID or ProductID can be specified in a GetSearchResults request, but not both. See the Developer's Guide for information on the categories that support usage of this field in listing and searching use cases. Not applicable when revising and relisting items. For Half.com listing use cases, contains an ISBN, UPC, or EAN value plus other meta-data. An industry-standard value that uniquely identifies the product. The valid values are dictated by the Type property. For convenience in AddItem, you can pass an eBay product ID as input (not limited to media categories). 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. Max length 10 for ISBN, 13 for EAN, 12 for UPC, and 4000 for ProductID. No max length for ticket keywords (passing too much data results in "no match found" errors). Only ISBN and UPC values can be passed in GetSearchResults. For AddItem and GetSearchResults, required if Type is specified. Required for Half.com listing use cases, and this can only be an ISBN, UPC, or EAN value. GetSearchResultsExpress returns this value in ProductArray.Product.ExternalProductID.Value. To pass an external product ID in the request, use ExternalProductIDValue. See description AddItem GetItemRecommendations GetSearchResults VerifyAddItem Conditionally GetSellerPayments Conditionally GetSearchResultsExpress Conditionally 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. AddItem GetItemRecommendations VerifyAddItem No The kind of identifier being passed in. The choices are listed in the ExternalProductCodeType code list. For AddItem and GetSearchResults, required if Value is specified. For Half.com listing use cases, only ISBN, UPC, and EAN are supported. GetSearchResultsExpress returns this value in ProductArray.Product.ExternalProductID.Type. To pass an external product ID in the request, use ExternalProductIDType. AddItem GetItemRecommendations GetSearchResults VerifyAddItem Conditionally GetSellerPayments Conditionally GetSearchResultsExpress Conditionally Container for external transaction information. Unique payment transaction ID. GetItemTransactions GetSellerTransactions Conditionally ReturnAll GetOrderTransactions Conditionally none, ReturnAll Date on which transaction occurs in PayPal. GetItemTransactions GetSellerTransactions Conditionally ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetItemTransactions GetSellerTransactions Conditionally ReturnAll GetOrderTransactions Conditionally none, ReturnAll 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 Conditionally ReturnAll GetOrderTransactions Conditionally none, ReturnAll A container node for definitions of the features specified in FeatureID in the GetCategoryFeatures request. If no feature ID was specified, all definitions are returned. Specifies one or more sets of listing durations. Each set gives durations for listing types a category could allow. If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Use the data provided in SiteDefaults and Category to determine which listing formats support each listing duration and whether any categories override the standard settings. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally Some categories allow you to enhance a listing by putting it into a rotation for display on a special area of the eBay home page. Item or feedback restrictions may apply. If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally Defines the ProPack feature (a feature pack). If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally Defines the BasicUpgradePack bundle feature (a feature pack). Applicable to Australia site (site ID 15, abbreviation AU) only. If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally Defines the ValuePack bundle feature (a feature pack). If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally Defines the ProPackPlus bundle feature (a feature pack). If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally eBay enables you to list and sell digital files (such as Adobe PDF files) or information that buyers can access online or have delivered electronically. If a category supports digital listings, it means that you have the option to list digital items in that category (i.e., Item.DigitalDeliveryDetails can be specified in your listing request). It does not mean the category requires you to list items digitally. Digital listings are not eligible for eBay Express. If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories (if any) support this feature. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally For the US and Germany sites, an eBay item must meet a number of eligibility requirements in order to also be included on eBay Express. One requirement is that the category needs to support Express. For example, categories that are not covered by PayPal Buyer Protection (e.g., Live Auctions and Motors vehicles) are excluded from Express. If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories are enabled for Express. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally For the US and Germany sites, an eBay item must meet a number of eligibility requirements in order to also be included on eBay Express. One requirement is that the item must include a picture (or gallery image). Some categories (e.g., Event Tickets) may waive this requirement if a picture is not normally expected. If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories requires an item to include a picture in order to be eligible for Express. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally For the US and Germany sites, an eBay item must meet a number of eligibility requirements in order to also be included on eBay Express. One requirement is that the item must include the Item Condition attribute (using Item Specifics). Some categories may waive this requirement. If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Currently, this field contains no other special meta-data. (An empty element is returned.) Use the data provided in SiteDefaults and Category to determine which categories require an item to include the Item Condition attribute in order to be eligible for Express. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally If present, the corresponding feature ID was passed in the request or all features were requested (i.e., no feature IDs were specified). Beginning in mid- to late June, 2006, on the Germany, Austria, Belgium French, and Belgium Dutch sites, Minimum Reserve Price is supported for the Art and Antiques, Watches and Jewelry, and Motorbikes categories. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally Applies to the US eBay Motors site (except Parts and Accessories category). Defines the Transaction Confirmation Request feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally Reserved for future use. GetCategoryFeatures none, ReturnSummary, ReturnAll Conditionally Specifies the feature IDs for which you want information. If you do not specify a value, it defaults to all feature IDs. (in) Returns information about the durations of listings you can use in a given category. GetCategoryFeatures No (in) Returns information about whether a category supports best offers. GetCategoryFeatures No (in) Returned if a site and category allow Buy It Now for Dutch auctions. GetCategoryFeatures No (in) Returns information about whether a seller is required to specify a shipping service and associated cost in order to list the item. GetCategoryFeatures No (in) Returns information about whether a bidder must consent to the bid by confirming that he or she read and agrees to the terms in eBay's privacy policy. GetCategoryFeatures No (in) Indicates whether or not it is possible to enhance a listing by putting it into a rotation for display on a special area of the eBay home page. Support for this feature varies by site. Item or feedback restrictions may apply. GetCategoryFeatures No (in) Indicates whether the category supports ad-format GetCategoryFeatures No (in) Returns information about whether a category supports counter offers for best offers. GetCategoryFeatures No (in) Returns information about whether a category supports auto decline for best offers. GetCategoryFeatures No (in) Returns information about ProPackBundle (a feature pack). Applies only to US and Canadian eBay motor vehicle sellers. Contains the Bold, Border, Featured and Highlight features. GetCategoryFeatures No (in) Returns information about the BasicUpgradePack bundle (a feature pack), which combines the features Gallery and Subtitle for a discounted price. Australia site (site ID 15, abbreviation AU) only. Effective beginning February 22, 2006. GetCategoryFeatures No (in) Returns information about the ValuePack bundle (a feature pack), which combines the features Gallery, Subtitle, and Listing Designer for a discounted price. Support for this feature varies by site and category. Effective beginning February 22, 2006. GetCategoryFeatures No (in) Returns information about the ProPackPlus bundle (a feature pack), which combines the features BoldTitle, Border, Highlight, Featured, and Gallery for a discounted price. Support for this feature varies by site and category. Effective beginning February 22, 2006. GetCategoryFeatures No (in) Returns information about whether a category supports local market speciality subscription. GetCategoryFeatures No (in) Returns information about whether a category supports local market regular subscription. GetCategoryFeatures No (in) Returns information about whether a category supports local market premium subscription. GetCategoryFeatures No (in) Returns information about whether a category supports local market non subscription. GetCategoryFeatures No (in) Returns information about whether a category is eligible for eBay express GetCategoryFeatures No (in) Returns information about whether a category requires pictures to be listed on express. GetCategoryFeatures No (in) Returns information about whether a category requires item condition to be listed on express. GetCategoryFeatures No Reserved for future use. GetCategoryFeatures No (out) Reserved for internal or future use. GetCategoryFeatures No (in) Returns information about whether a category supports Minimum Reserve Price. GetCategoryFeatures No (in) Returns information about whether a category supports the Transaction Confirmation Request (TCR) feature. GetCategoryFeatures No Identifies the name and monetary amount of a fee that a member pays to eBay (or an eBay company). These fee names and values 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 fee, for identification purposes. See the eBay Web Services guide for a list of current fee names. Fees Resulting from Listing an Item http://developer.ebay.com/DevZone/XML/docs/WebHelp/ListingItems-Fees_Resulting_from_Listing_an_Item.html AddItem AddLiveAuctionItem AddSecondChanceItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem VerifyAddSecondChanceItem Always Amount of the fee that eBay will charge the member for the item. See the eBay.com Web site online help for a current fee schedule. eBay.com Fees http://pages.ebay.com/help/sell/fees.html AddItem AddLiveAuctionItem AddSecondChanceItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem VerifyAddSecondChanceItem Always Contains multiple individual feedback detail entries. (out) Contains a single feedback detail entry. Output only. GetFeedback Conditionally ReturnAll Detailed feedback information for a user. Conveys the score for the feedback, textual comment from the leaving user, and other information. (out) eBay user ID for the user who left the feedback. Returned for a detail level of ReturnAll (if the parent is returned). GetFeedback Conditionally ReturnAll (out) Feedback score of the user indicated in CommentingUser. Returned for a detail level of ReturnAll (if the parent is returned). GetFeedback Conditionally ReturnAll (out) Text message left by user specified in CommentingUser. Used to provide a more in-depth description of the user's opinion of their transaction with the user about whom they left feedback. Returned as text in the language that the comment was originally left in. Returned for a detail level of ReturnAll (if the parent is returned). 80 (125 for Taiwan) GetFeedback Conditionally ReturnAll (out) Date and time (in GMT) that the feedback was submitted to eBay. Returned for a detail level of ReturnAll (if the parent is returned). GetFeedback Conditionally ReturnAll (out) Type of feedback. Can be Positive, Neutral, Negative, or Withdrawn (see the CommentTypeCodeType code list). Positive feedbacks add to the user's total feedback score, negative feedbacks lower the score, and neutral feedbacks do not affect the score (but do affect the overall picture of the user's online reputation). Returned for a detail level of ReturnAll (if the parent is returned). GetFeedback Conditionally ReturnAll (out) Textual comment that the user targeted by feedback may leave in response or rebuttal to the feedback. (Cannot be submitted or edited via the API.) 80 (125 for Taiwan) GetFeedback Conditionally ReturnAll (out) Explanation a user can give to a response. (Cannot be submitted or edited via the API.) Returned for a detail level of ReturnAll (if the parent is returned). 80 (125 for Taiwan) GetFeedback Conditionally ReturnAll (out) The ID that uniquely identifies the item listing. Returned for a detail level of ReturnAll (if the parent is returned). 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetFeedback Conditionally ReturnAll (out) Indicates whether the user who was the feedback recipient was a Buyer or the Seller for that transaction. Returned for a detail level of ReturnAll (if the parent is returned). GetFeedback Conditionally ReturnAll (out) Name of the listing for which feedback was provided. Returned as CDATA. This value is returned only if the site is China (site ID 223). 55 CN GetFeedback Conditionally ReturnAll (out) The final price for the item, associated with the currency identified by the currencyId attribute of the AmountType. This value is returned only if the site is China (site ID 223). GetFeedback Conditionally ReturnAll (out) Unique identifier for the feedback entry. Returned for a detail level of ReturnAll (if the parent is returned). GetFeedback Conditionally ReturnAll (out) Unique identifier for the transaction about which this feedback entry was left. Returned for a detail level of ReturnAll (if the parent is returned). 10 GetFeedback Conditionally ReturnAll (out) Indicates whether eBay replaced the comment with a message that the comment was removed. GetFeedback Conditionally ReturnAll (out) Indicates whether eBay replaced the response with a message that the response was removed. GetFeedback Conditionally ReturnAll (out) Indicates whether eBay replaced the follow-up with a message that the follow-up was removed. GetFeedback Conditionally ReturnAll Information used to add a feedback note for a user. Textual comment that explains, clarifies, or justifies the feedback rating specified in CommentType. Still displayed if feedback is withdrawn. CompleteSale No GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll GetOrderTransactions Conditionally none Rating of the feedback being left (e.g., Positive). CompleteSale No GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll GetOrderTransactions Conditionally none GetMyeBayBuying Conditionally WonList Recipient user for whom the feedback is being left. CompleteSale No GetItemsAwaitingFeedback Conditionally FeedbackLeft FeedbackReceived GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll GetOrderTransactions Conditionally none Container for a set of feedback statistics. Contains zero one or multiple FeedbackPeriod objects. Output only, for the summary feedback data returned by GetFeedback. (out) Contains one feedback statistic giving length of the period being reported (e.g. last 7 days prior to the call), and total number of feedback entries (of the type given by the container, e.g. positive feedback) submitted during the indicated period. Returned if no detail level is specified. GetFeedback Conditionally none, ReturnAll Contains the data for one type of feedback for one predefined time period. Parent FeedbackPeriodArrayType object indicates the type of feedback counted: positive, neutral, negative, or total. Output only, in the summary feedback data returned by GetFeedback. (out) Indicates the time period for the feedback count. Returns a value indicating the number of days prior to the call for which feedbacks of the particular type are counted. Returned if no detail level is specified. GetFeedback Conditionally none, ReturnAll (out) Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays. Returned if no detail level is specified. GetFeedback Conditionally none, ReturnAll FeedbackRatingStarCodeType - Type declaration to be used by other schema. 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. (out) No graphic displayed, feedback score 0-9. (out) Yellow Star, feedback score 10-49. (out) Blue Star, feedback score 50-99. (out) Turquoise Star, feedback score 100-499. (out) Purple Star, feedback score 500-999. (out) Red Star, feedback score 1,000-4,999 (out) Green Star, feedback score 5,000-9,999. (out) Yellow Shooting Star, feedback score 10,000-24,999. (out) Turquoise Shooting Star, feedback score 25,000-49,999. (out) Purple Shooting Star, feedback score 50,000-99,999. (out) Red Shooting Star, feedback score 100,000 and above. (out) Reserved for internal or future use. Types of feedback responses. A reply to feedback left by another user. A follow-up to a feedback comment left for another user. Specifies all feedback summary information (except Score). Contains FeedbackPeriodArrayType objects that each convey feedback counts for positive, negative, neutral, and total feedback counts - for various time periods each. Also conveys counts of bid retractions for the predefined time periods. (out) Bid retractions count, for multiple predefined time periods preceding the call. Returned if no detail level is specified. GetFeedback Conditionally none, ReturnAll (out) Negative feedback entries count, for multiple predefined time periods preceding the call. Returned if no detail level is specified. GetFeedback Conditionally none, ReturnAll (out) Neutral feedback entries count, for multiple predefined time periods preceding the call. Returned if no detail level is specified. GetFeedback Conditionally none, ReturnAll (out) Positive feedback entries count, for multiple predefined time periods preceding the call. Returned if no detail level is specified. GetFeedback Conditionally none, ReturnAll (out) Total feedback score, for multiple predefined time periods preceding the call. Returned if no detail level is specified. GetFeedback Conditionally none, ReturnAll (out) Number of neutral comments received from suspended users. Returned if no detail level is specified. GetFeedback Conditionally none, ReturnAll (out) Number of unique negative comments. Returned if no detail level is specified. GetFeedback Conditionally none, ReturnAll (out) Number of unique positive comments. Returned if no detail level is specified. GetFeedback Conditionally none, ReturnAll 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 data for one fee (such as name and amount). AddItem AddLiveAuctionItem AddSecondChanceItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem VerifyAddSecondChanceItem Always A set of financing offers: promotional offers that allow a buyer to purchase items on credit. A financing offer. GetFinanceOffers Conditionally ReturnAll A promotional offer that allow the buyer to purchase items on credit. The unique ID associated with a particular financing offer. This value is used in other calls such as AddItem to indicate that an item has a particular financing offer. GetFinanceOffers Conditionally ReturnAll Text that the buyer sees describing the details of the financing offer. GetFinanceOffers Conditionally ReturnAll Text that the seller sees describing the details of the financing offer. GetFinanceOffers Conditionally ReturnAll Date on which the offer first becomes active. GetFinanceOffers Conditionally ReturnAll The date the offer was last modified. GetFinanceOffers Conditionally ReturnAll The minimum amount for an item to which the offer applies. GetFinanceOffers Conditionally ReturnAll Interest charges associated with the finance offer. GetFinanceOffers Conditionally ReturnAll The priority of the financing offer. GetFinanceOffers Conditionally ReturnAll Flat Rate Insurance Ranges Range from 0.01 to 9.99 Range from 10.00 to 49.99 Range from 50.00 to 99.99 Range from 100.00 to 199.99 Range from 200.00 to 299.99 Range from 300.00 to more Reserved for internal or future use Insurance Cost for Item Price Range The price range for the shipment for which the insurance cost is being specified. GetUserPreferences Conditionally SetUserPreferences No The cost of insurance for the specified price range. GetUserPreferences Conditionally SetUserPreferences No If the user specifies ChargeAmountForEachAdditionalItem for FlatShippingRateOption, then this value is used to specify how much to charge for each additional item. GetUserPreferences Conditionally SetUserPreferences No If the user specifies DeductAmountFromEachAdditionalItem for FlatShippingRateOption, then this value is used to specify how much to deduct for each additional item shipped. GetUserPreferences Conditionally SetUserPreferences No For the given range, specifies the cost of insurance. If the InsuranceOption is either Optional or Required, then 6 instances of this field must be specifies, one for each cost range. GetUserPreferences Conditionally SetUserPreferences No Specifies how the user wants flat-rate shipping to be calculated. GetUserPreferences Conditionally SetUserPreferences No (in/out) Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Flat and calculated shipping. GetUserPreferences Conditionally SetUserPreferences No Flat Shipping Rate Options Charge highest shipping cost for the first item and X amount for each additional item. Charge highest shipping cost for the first item and deduct X amount from the shipping cost of each additional item. Charge highest shipping cost for the first item and ship each additional item free. Reserved for internal or future use. Specifies how cross-promoted items with gallery images should be displayed. (in/out) Show any items, in no particular order. (in/out) Show items with gallery images first, before other items. (in/out) Show only items with gallery images. (out) Reserved for internal or future use. GalleryTypeCodeType - 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. (in/out) 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. 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. 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. AddItem ReviseItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetItem GetMyeBayBuying GetMyeBaySelling GetSearchResults Conditionally (in/out) Listing is highlighted and included at the top of search results. When "Featured" is included in an item listing, the listing also automatically gets the Gallery and Gallery Plus functionality. "Gallery" and "Plus" do not need to be specified separately in the listing. Passing "Featured", "Plus", and "Gallery" in the same request will return an error. For eBay Motors (SiteId 100), this may also feature certain items on the eBay Motors home page. Not applicable to eBay Stores Inventory listings. AddItem AddLiveAuctionItem ReviseItem ReviseLiveAuctionItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetItem GetMyeBayBuying GetMyeBaySelling GetSearchResults Conditionally (in/out) 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. 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. AddItem ReviseItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetItem GetMyeBayBuying GetMyeBaySelling GetSearchResults Conditionally (in/out) 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. 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). Note that the Gallery Plus feature requires that the image be hosted with the eBay Picture Service (EPS). One EPS image is included at no cost with the Gallery Plus feature. When "Plus" is included in an item listing, the listing also automatically gets the Gallery functionality. "Gallery" does not need to be specified separately in the listing. Passing "Featured", "Plus", and "Gallery" in the same request will return an error. Not applicable to eBay Stores Inventory listings. AddItem AddLiveAuctionItem ReviseItem ReviseLiveAuctionItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetItem GetMyeBayBuying GetMyeBaySelling GetSearchResults Conditionally (out) Reserved for internal or future use. AddItem ReviseItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetItem GetMyeBayBuying GetMyeBaySelling GetSearchResults Conditionally GeneralPaymentMethodCodeType - Type declaration to be used by other schema. This code identifies the general types of payment means, e.g., used by payment service provider applications. (out) Custom Code. (in/out) Electronic check. (in/out) ACH. (in/out) Credit-card. (in/out) Pay balance. (out) Reserved for internal or future use. Specifies which bidder information to return. (in) Returns all bidders for an ended or still-active listing. It may be used by any user. (in) Returns all non-winning bidders for ended listings only. It may be used only by a seller. (in) Returns all non-winning bidders for an ended listing who have not yet received a Second Chance Offer and noted interest in receiving a Second Chance Offer. It may be used only by a seller. (out) Reserved for internal or future use. Specifies the data for a single item and configures the recommendation engines to use when processing the item with GetItemRecommendations. The listing flow for which the seller is seeking Listing Analyzer recommendations. Not applicable to results from other recommendation engines (i.e., the Suggested Attributes engine or the Product Pricing engine). The default flow is AddItem. GetItemRecommendations No AddItem Contains fields that describe the item for which you are seeking recommendations. If the Listing Analyzer recommendation engine is run, the applicable fields are the same as the fields for AddItem, ReviseItem, or RelistItem requests, as determined by the value specified in ListingFlow. The item ID (Item.ItemID) is required when the ListingFlow is ReviseItem or RelistItem, and it is not applicable when the ListingFlow is AddItem. All other item fields are optional, even if listed as required for other calls. However, as some tips are dependent on the properties of the item, and as some properties have dependencies on other properties, we strongly recommend that you include all the item properties that will be included in the AddItem, ReviseItem, or RelistItem request. When the Listing Analyzer engine is run, tips will only be returned for fields that are specfied on the item. When the Product Pricing engine is run, pricing data will be based on the catalog product you specify. GetItemRecommendations Yes This field will be removed in a future release. 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. Causes eBay to list the item with Pre-filled Item Information based on an ISBN value, UPC value, EAN value, ticket keywords, or eBay catalog product ID, plus other meta-data that you specify. Only applicable when the value of ListingFlow is AddItem. See Item.ExternalProductID for more information and validation rules. GetItemRecommendations No Applicable when the ListingFlow is ReviseItem or RelistItem. Array of item properties that are being changed. In release 439 and later, ModifiedFields is no longer required to revise field values, but it is still supported for backward compatibility. See the Developer's Guide for rules on adding, modifying, and removing values when revising or relisting items. GetItemRecommendations Conditionally A recommendation engine to run. If no engines are specified, all available recommendation engines will run. Some engines require additional fields, such as Item.PrimaryCategory.CategoryID, to be specified. If the ProductPricing engine is specified but Item.ProductListingDetails is not specified, no Product Pricing engine results are returned. GetItemRecommendations No One or more keywords to search for when using the Suggested Attributes engine. Required when SuggestedAttributes is specified as the recommendation engine (including when no recommendation engines are specified). Only the listing title is searched. The words "and" and "or" are treated like any other word. Blank searches are not allowed (and result in a warning). 350 (characters) GetItemRecommendations Conditionally Unique key to identify the response that matches this recommendation request container. Use this key to distinguish between responses when multiple recommendation containers are specified (i.e., for batch requests). You define the key. To be useful, each correlation ID should be unique within the same call. That is, define a different correlation ID for each recommendation request container. (eBay does not validate the uniqueness of these IDs.) If specified, the same correlation ID will be returned in the corresponding recommendation response (or error response). We recommend that you use this when retrieving recommendations for multiple items at once. GetItemRecommendations No Specifies the name of the field to remove from a listing. Applicable when the ListingFlow is ReviseItem or RelistItem. See the Developer's Guide for rules on removing values when revising or relisting items. DeletedField accepts the following values for removing fields: item.pictureDetails.pictureURL, item.pictureDetails.galleryURL, item.listingDesigner.themeID, item.listingDesigner.layoutID, item.payPalEmailAddress, item.proximitySearchDetails.postalCode, item.shippingDetails.paymentInstructions, and item.SKU. When the ListingFlow is RelistItem, the following values for DeletedField are also allowed: item.charity, item.secondaryCategory, and item.subTitle. DeletedField is case sensitive. The request can contain zero, one, or many instances of DeletedField. GetItemRecommendations Conditionally Returns recommended changes or opportunities for improvement related to listing data that was passed in a GetItemRecommendations request. Contains tips returned from the Listing Analyzer recommendation engine, if this engine was specified in the request (or if no engine was specified). GetItemRecommendations Conditionally Reserved for future use. Contains pricing data returned from the Product Pricing engine, if this engine was specified in the request (or if no engine was specified). GetItemRecommendations Conditionally Contains attribute suggestions returned from the Suggested Attributes engine, if this engine was specified in the request. The results include suggested attributes and values based on the primary category and a string you specify in the Query field. Suggestions may only be returned when the Suggested Attributes engine is specified alone. If you request recommendations by using multiple engines, suggested attribute data might not be returned. If attributes are returned with multiple values, the values are returned in order of rank (i.e., the value that best meets eBay's recommendation criteria is returned first). GetItemRecommendations Conditionally Contains zero or more product titles and IDs returned from the Suggested Attributes engine, if this engine was specified in the request (or if no engine was specified). If applicable, use one of the suggested product IDs to list the item with Pre-filled Item Information. GetItemRecommendations Conditionally Unique key to distinguish between recommendations for each item. Matches a correlation ID you defined in the request, if any. GetItemRecommendations Conditionally 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. (in/out) The seller is offering to ship the item via an express shipping method as explained in the item description. AddItem RelistItem ReviseItem VerifyAddItem No (in/out) The seller is offering to ship to the gift recipient (instead of to the buyer) after payment clears. AddItem RelistItem ReviseItem VerifyAddItem No (in/out) The seller is offering to wrap the item (and optionally include a card) as explained in the item description. AddItem RelistItem ReviseItem VerifyAddItem No (out) Reserved for internal or future use Specifies a predefined subset of fields to return. The predefined set of fields can vary for different calls. Only applicable to certain calls (see request types that include a GranularityLevel property). For calls that support this filter, see the eBay Web Services guide for a list of the output fields that are returned for each level. Only one level can be specified at a time. For GetSellerList, use DetailLevel or GranularityLevel in a given request, but not both. For GetSellerList, if GranularityLevel is specified, DetailLevel is ignored. (in) For each record in the response, retrieves less data than Medium. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified. GetSellerList No For each record in the response, retrieves more data than Medium. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified. GetSellerList No For each record in the response, retrieves more data than Coarse and less data than Fine. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified. GetSellerList No 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. (in/out) No hit counter. The number of page views will not be available. (in/out) 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 (in/out) 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 (in/out) 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 (in/out) A basic style hit counter. (in/out) A retro, computer-style hit counter. (in/out) A hidden hit counter. The number of page views will only be available to the item's seller. (out) Reserved for internal or future use Defines whether Home Page Featured is available on the site. The seller's requirements regarding whether the buyer pays for shipping insurance. (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. (in/out) The seller requires that the buyer pay for shipping insurance. (in/out) The seller does not offer shipping insurance to the buyer. (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. (in/out) 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. (out) Reserved for internal or future use The insurance selected by the buyer. Shipping insurance was not offered. Shipping insurance was offered but not selected. Shipping insurance was offered and selected. Shipping insurance was required. Shipping insurance was included in Shipping and Handling fee. (out) Reserved for internal or future use. Shipping costs and options related to an international shipping service. When used as input, if one is provided, at least one domestic ShippingService must be provided. This type does not exist before compatibility level 383. (in/out) An international shipping service offered for shipping the item (for example, UPS Ground). For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping. SendInvoice No AddItem AddOrder GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItem GetItemShipping GetOrders Conditionally GetOrderTransactions Conditionally none GetItemTransactions Conditionally none, ReturnAll (in/out) 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. SendInvoice No AddItem GetItemRecommendations AddOrder RelistItem ReviseItem VerifyAddItem Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItem GetItemShipping GetOrders Conditionally GetOrderTransactions Conditionally none GetItemTransactions Conditionally none, ReturnAll Getting Shipping Cost Information http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts (in/out) Cost of shipping each additional item beyond the first item. Should be zero for single-item listings. Default value is 0.00. For flat shipping only. SendInvoice No AddItem GetItemRecommendations AddOrder RelistItem ReviseItem VerifyAddItem No GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItem GetItemShipping GetOrders Conditionally GetOrderTransactions Conditionally none GetItemTransactions Conditionally none, ReturnAll (in/out) Seller-preferred presentation order relative to other service options. Valid values are: 1, 2 and 3 (first, second and third choices). For flat and calculated shipping. SendInvoice No AddItem GetItemRecommendations AddOrder RelistItem ReviseItem VerifyAddItem Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItem GetItemShipping GetOrders Conditionally GetOrderTransactions Conditionally none GetItemTransactions Conditionally none, ReturnAll An international location or region to which the item may be shipped via this particular shipping service. Associated with the shipping service by the seller. Use GeteBayDetails to determine which locations are valid per site. These values are string equivalents of values found in ShippingRegionCodeType and CountryCodeType. For the AddItem family of calls, this field is required if any international shipping service has been specified. SendInvoice No GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItem GetItemShipping GetOrders Conditionally GetOrderTransactions Conditionally none GetItemTransactions Conditionally none, ReturnAll AddItem GetItemRecommendations AddOrder RelistItem ReviseItem VerifyAddItem Conditionally Container for a list of items. Can contain zero, one, or multiple ItemType objects, each of which conveys the data for one item listing. Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request. Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has a transactional relationship with that buyer. For calls that support detail levels, the set of fields returned is also controlled by the value of DetailLevel in the request. For some calls, other parameters in the request can also control the data returned for each item. For example, GranularityLevel controls the fields to return for each item in the GetSellerList response. For GetSearchResultsExpress, ItemDetails controls the fields to return for each item. GetBidderList Always GetCategoryListings GetMyeBaySelling Conditionally GetSellerList Conditionally none, ItemReturnDescription, ReturnAll GetSellerEvents Conditionally none, ReturnAll GetMyeBayBuying Conditionally BestOfferList BidList LostList WatchList none, ReturnSummary, ReturnAll GetSearchResultsExpress Conditionally Specifies that you want to display items based on selling format, such as Buy It Now or Store items. (in/out) Show any items, in no particular order. (in/out) Show items with a Buy It Now price first. (in/out) Show only items with a Buy It Now price. (in/out) Show only store inventory items. (out) Reserved for internal or future use. Type that represents the unique identifier for a single item listing. Defines how a list of items should be returned. Returns the list using the default settings. GetMyeBayBuying No BestOfferList Specifies the listing type of items in the returned list. Valid for ActiveList. GetMyeBayBuying No BestOfferList GetMyeBaySelling No ActiveList Specifies how the items returned should be sorted. Valid for WatchList, BidList, WonList, LostList, ScheduledList, ActiveList, UnsoldList, and GetItemsAwaitingFeedback. GetMyeBayBuying No BestOfferList BidList LostList WatchList WonList GetMyeBaySelling No Specifies the time period during which an item was won or lost. Similar to the Period drop-down menu in the My eBay user interface. Valid for WonList, LostList, SoldList, UnsoldList, BuyingReminders, and SellingReminders. 0 60 GetMyeBayBuying No BestOfferList LostList WonList Specifies whether to include Item.PrivateNotes and Item.eBayNotes in the response. Valid for WatchList, BidList, WonList, LostList, ScheduledList, ActiveList, SoldList, and UnsoldList. GetMyeBayBuying No BestOfferList BidList LostList WatchList WonList GetMyeBaySelling No Specifies how to create virtual pages in the returned list. Valid for BidList, WonList, LostList, ScheduledList, ActiveList, SoldList, UnsoldList, and GetItemsAwaitingFeedback. Default for EntriesPerPage with GetMyeBayBuying is 200. GetMyeBaySelling No GetMyeBayBuying No BestOfferList BidList LostList WonList ItemLocationCodeType - Type declaration to be used by other schema. Use with Country Code argument in GetSearchResults. Items available to the specified country. Items located in the specified country. (out) Reserved for internal or future use. Specifies how items should be sorted. (in/out) Sort items by ending time, with items ending last first. (in/out) Sort items by ending time, with items ending soonest first. (in/out) Sort items by price, with the highest price first. (in/out) Sort items by price, with the lowest price first. (in/out) Sort items by listing time, with newly listed items first. (in/out) Sort items in a randomly selected order. (out) Reserved for internal or future use. (in) Indicates the field and direction (ascending or descending) by which to sort a returned list of items. (in) Sort by Item ID (ascending). GetMyeBayBuying No BestOfferList GetMyeBayBuying No BidList GetMyeBayBuying No LostList GetMyeBayBuying No WatchList GetMyeBayBuying No WonList (in) Sort by price (ascending). (in) Sort by start price (ascending). GetMyeBayBuying No BidList GetMyeBayBuying No LostList GetMyeBayBuying No WatchList GetMyeBayBuying No WonList (in) Sort by item title (ascending). GetItemsAwaitingFeedback No (in) Sort by number of bids on the item (ascending). GetMyeBayBuying No LostList GetMyeBayBuying No WatchList (in) Sort by quantity (ascending). GetMyeBayBuying No BestOfferList (in) Sort by listing start time (ascending). GetMyeBayBuying No BestOfferList GetMyeBayBuying No BidList GetMyeBayBuying No LostList GetMyeBayBuying No WatchList (in) Sort by listing end time (ascending). GetMyeBayBuying No WonList GetItemsAwaitingFeedback No (in) Sort by the seller's user ID, in alphabetical order. GetMyeBayBuying No BestOfferList GetMyeBayBuying No BidList GetMyeBayBuying No LostList GetMyeBayBuying No WatchList GetMyeBayBuying No WonList (in) Sort by the time left for the item's listing, in ascending order: active items, good-til-cancelled items, and completed items. GetMyeBayBuying No BestOfferList GetMyeBayBuying No BidList GetMyeBayBuying No WatchList (in) Sort by listing duration (ascending). (in) Sort by listing type (ascending). (in) Sort by current price (ascending). GetMyeBayBuying No BestOfferList GetMyeBayBuying No BidList GetMyeBayBuying No LostList GetMyeBayBuying No WatchList GetMyeBayBuying No WonList (in) Sort by reserve price (ascending). (in) Sort by maximum bid price (ascending). GetMyeBayBuying No BidList GetMyeBayBuying No LostList GetMyeBayBuying No WatchList GetMyeBayBuying No WonList (in) Sort by number of bidders (ascending). (in) Sort by the user ID of the highest bidder (ascending). GetMyeBayBuying No BidList GetMyeBayBuying No LostList GetMyeBayBuying No WatchList (in) Sort by the user ID of the buyer (ascending). (in) Sort by the buyer's postal code (ascending). (in) Sort by the buyer's email address, in alphabetical order. (in) Sort by the seller's email address, in alphabetical order. (in) Sort by total price (ascending). GetMyeBayBuying No WonList (in) Sort by the number of items being watched (ascending). The WatchCount of an item is the number of watches that buyers have placed on an item using their eBay accounts. (in) Sort by the number of best offers (ascending). (in) Sort by the number of questions (ascending). (in) Sort by the cost indicated for shipping (ascending). GetMyeBayBuying No BestOfferList GetMyeBayBuying No BidList GetMyeBayBuying No WatchList GetMyeBayBuying No WonList (in) Sort by type of feedback received, positive, negative, or neutral. In ascending order - negative, neutral, positive. GetItemsAwaitingFeedback No (in) Sort by type of feedback received, positive, negative, or neutral. In ascending order - negative, neutral, positive. GetItemsAwaitingFeedback No (in) Sort by user ID, in alphabetical order. GetItemsAwaitingFeedback No (in) Sort by the number of items sold (ascending). (in) Sort by the number of items available (ascending). (in) Sort by the number of items purchased (ascending). GetMyeBayBuying No WonList (in) Sort by the platform on which the item was won (eBay items last). GetMyeBayBuying No WonList (in) Sort by the platform on which the item was sold (eBay items last). GetMyeBaySelling No SoldList (in) Sort by the duration of the listing (descending). (in) Sort by the listing type (descending). (in) Sort by the current price of the listed item (descending). (in) Sort by the listing's reserve price (descending). (in) Sort by the highest bid on the item (descending). (in) Sort by number of bidders (descending). (in) Sort by the user ID of the highest bidder (descending). (in) Sort by the user ID of the buyer, in reserve alphabetical order. (in) Sort by the buyer's postal code, in descending order. (in) Sort by the buyer's email address, in reverse alphabetical order. (in) Sort by the seller's email address, in reverse alphabetical order. (in) Sort by the total price of the order, (descending). (in) Sort by watch count (descending). (in) Sort by number of questions (descending). (in) Sort by the cost of shipping (descending). (in) Sort by type of feedback received, positive, negative, or neutral. In descending order - positive, neutral, negative. GetItemsAwaitingFeedback No (in) Sort by type of feedback received, positive, negative, or neutral. In descending order - positive, neutral, negative. GetItemsAwaitingFeedback No (in) Sort by user ID, in descending order. GetItemsAwaitingFeedback No (in) Sort by Item ID (descending). (in) Sort by price (descending). (in) Sort by start price (descending). (in) Sort by item title (descending). GetItemsAwaitingFeedback No (in) Sort by number of bids on the item (descending). (in) Sort by the quantity of items sold (descending). (in) Sort by listing start time (descending). (in) Sort by listing end time (descending). GetItemsAwaitingFeedback No (in) Sort by seller user ID, in reverse alphabetical order. (in) Sort by time left on the listing, in descending order: completed items, good-til-cancelled items, and active items. (in) Sort by the platform on which the item was won (ebay Express items last). GetMyeBayBuying No WonList (in) Sort by the platform on which the item was sold (ebay Express items last). GetMyeBaySelling No SoldList (out) Reserved for internal or future use. Details about items involved in the summary for the specified time period. Number of items involved in the summary. Total value associated with the items in this summary. Container of ItemTransactionIDs. An ItemID-TransactionID container. GetOrderTransactions Conditionally A container for item and transaction IDs. The ID of an item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetOrderTransactions Conditionally The ID of a transaction. 10 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 re-list 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. ApplicationData is not applicable to Half.com. For Half.com listings, use SellerInventoryID instead. 32 AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetSellerList ItemReturnDescription, ReturnAll Conditionally GetBidderList GetMyeBay Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions none Conditionally Item Specifics (such as new or used condition) to include in a listing. Carries one or more instances of AttributeSet in a list. For Item Specifics in general, an item will be associated with no more than two full attribute sets (one for the primary category and one for the secondary category). For some international sites, an item can specify additional site-wide attribute sets. Some categories (such as Event Tickets and US Real Estate) require Item Specifics. See "Working with Attribute-Based Features" in the eBay Web Services Guide for information on working with Item Specifics. Use GetCategory2CS and GetAttributesCS to determine when attributes are required for a category. Also see "Specifying an Item's Condition". For a listing to be eligible for eBay Express, the item condition is required in most cases. Some categories are exempt from this requirement. See "eBay Express" in the eBay Web Services Guide. When you revise a listing, if the listing has bids and ends within 12 hours, you cannot change or add attributes. If the listing has bids but ends in more than 12 hours, you cannot change existing attribute data, but you can add attributes that were not previously specified. To delete all attributes when you revise or relist, specify Item.AttributeSetArray in DeletedField and don't pass AttributeSetArray in the request. For AddLiveAuctionItem and ReviseLiveAuctionItem, specify a maximum of one AttributeSet for Item Specifics that are associated with SecondaryCategory (a US eBay site category), plus any number of additional AttributeSet properties for site-wide attributes that are applicable to the US eBay site. For GetCategoryListings, AttributeSetArray can return the item condition (not other Item Specifics) for eBay Germany. GetSearchResults can return Item Specifics when the request either specifies IncludeCondition as true or specifies a product finder search, and a detail level of ItemReturnAttributes or ReturnAll. If IncludeCondition was true, AttributeSetArray may return the item condition (e.g., New). If SearchRequest was used to perform a product finder search, the list of attributes is limited to Item Specifics that would be included in the summary search results on the Web site, if any. For example, event ticket listings may return the venue name, section, and row. In some categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.) In GetItemRecommendations, if you use the Suggested Attributes engine, the engine interprets attributes you pass in as attributes that do NOT need recommendations (i.e., attributes that the seller has already filled in as desired). The engine only returns recommendations for attributes that you do not specify, and only for attributes associated with the primary category. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem AddLiveAuctionItem VerifyAddItem Conditionally GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem No GetBidderList GetCategoryListings GetSearchResults Conditionally GetItem ItemReturnAttributes, ReturnAll Conditionally Used to specify the item condition. Only applicable to Half.com (not eBay listings). You can revise this property for Half.com listings. This does not use the same Attributes format as eBay's Item Specifics. AddItem VerifyAddItem Yes ReviseItem No GetOrders Always Use this as a shortcut for specifying the Item Condition attribute by name instead of by ID. Only valid when using AddItem for items in Media categories (Books, DVD and Movies, Music, and Video Game categories). You can pass either AttributeSetArray or LookupAttributeArray, but you cannot pass both in the same request. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem VerifyAddItem No Multiple Item Shipping Discount. Seller specifies as input when listing, re-listing, or revising an item to indicate whether a shipping discount is to be applied when the buyer pays for the item in the checkout process and the item's transaction is combined with other transactions into an order. Returned with retrieved item data, indicating a shipping discount is applicable. Not returned by GetItem (see Item.ShippingDetails.ApplyShippingDiscount instead). Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Conditionally GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions none Conditionally If true, the seller requests immediate payment for the item. If false or not specified, immediate payment is not requested. (In responses, does not indicate whether the item is actually still a candidate for purchase via immediate payment.) Only applicable for items listed on PayPal-enabled sites in categories that support immediate payment (see AutoPayEnabled in GetCategories), when seller has a Premier or Business PayPal account (see PayPalAccountType in Getuser). If true, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods). Required for digitally delivered goods (see Item.DigitalDeliveryDetails). See the eBay Web Services guide section on Immediate Payment for additional requirements and dependencies. Also see the section on working with the eBay Motors site for additional rules. Not applicable to Half.com. false AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Always GetOrderTransactions none Always GetSellerList ItemReturnDescription, ReturnAll Conditionally Contains data associated with eBay Motors payments (Durations for deposit and full payments). Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem Conditionally Not applicable to Half.com. GetMyeBayBuying BidList LostList WonList none, ReturnSummary, ReturnAll Conditionally Listing upgrade that features the item in eBay search results on the mobile.de partner site. If true in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site. See the eBay Web Services Guide for applicable categories, revise and relist rules, and additional information on featuring vehicles on the Mobile.de Site. Not applicable to Half.com. GetSellerList ItemReturnDescription, ReturnAll Conditionally AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetCategoryListings GetItem GetSearchResults Conditionally Indicates the status of the item's eligibility for the PayPal Buyer Protection program. Not applicable to Half.com. GetSearchResults Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetBidderList Always GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Always GetOrderTransactions none Always For Chinese auction listings, Buy It Now allows a user to purchase the item at a fixed price and end the auction immediately. eBay China also supports Buy It Now for Dutch auction listings (see International Differences Overview in the eBay Web Services guide). Use this field to add Buy It Now and specify the amount a buyer would need to bid to take advantage of the Buy It Now feature. On the main eBay site, not applicable to fixed-price items (ListingTypeCodeType type StoresFixedPrice or FixedPriceItem), AdFormat listings, or Half.com listings. For fixed-price and Half.com listings, see StartPrice instead. See the eBay Web Services Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing. On most sites, once a Chinese auction has bids, the listing is no longer eligible for Buy It Now. However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that the seller set for the listing. You can use Item.SellingStatus.BidCount to determine whether an auction with Buy It Now has bids or not. With GetSearchResults, you can examine the Item.SearchDetails.BuyItNowEnabled flag to determine whether an auction is still a Buy It Now listing. With GetItem, you can examine the Item.ListingDetails.BuyItNowAvailable flag to determine whether a Dutch auction is still a Buy It Now listing. 16 AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetCategoryListings GetBestOffers GetMyeBay GetSearchResults Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItemTransactions GetSellerTransactions ReturnAll Conditionally GetOrderTransactions none Conditionally GetMyeBayBuying BestOfferList none, ReturnSummary, ReturnAll Conditionally GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetSellerEvents ReturnAll Conditionally Controls how eBay handles cases in which an ID specified in PrimaryCategory and/or SecondaryCategory no longer exists in the current category structure: If you pass a value of true in CategoryMappingAllowed, eBay will look up the current ID that is mapped to the same category and use the new ID for the listing (if any). The new ID will be returned in the response as CategoryID (for the primary category) or Category2ID (for the secondary category). If CategoryMappingAllowed is not set or contains a value of "false" (the default), an error will be returned if a selected category ID no longer exists. Not applicable to Half.com. AddItem GetItemRecommendations AddLiveAuctionItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No Identifies a Giving Works listing and the benefiting nonprofit charity organization selected by the charity seller, if any. If specified, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods). Giving Works listings are not eligible for eBay Express. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem VerifyAddItem No GetBidderList Conditionally GetItem ItemReturnDescription, ReturnAll Conditionally GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions none Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally Two-letter ISO 3166 country code. In some calls, used with the Location field to indicate the city and country where the item is located. Also applicable as input to AddItem and related calls when you list items to Half.com (specify US). In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. AddItem VerifyAddItem Yes GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItemRecommendations GetSearchResults Conditionally RelistItem ReviseItem No GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetSearchResultsExpress Conditionally 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. GetBidderList Conditionally GetItem 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 item-listing request. Also applicable as input to AddItem and related calls when you list items to Half.com (specify USD). You cannot modify a listing's currency when you revise or relist an item. AddItem GetItemRecommendations VerifyAddItem Yes GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Always GetOrderTransactions none Always GetSellerList ItemReturnDescription, ReturnAll Conditionally GetBestOffers GetCategoryListings GetMyeBay GetSearchResults Conditionally GetSellerEvents none, ReturnAll Conditionally Description of the item. In listing requests, you can submit your description using CDATA if you want to use HTML or XML-reserved characters in the description. An error is returned if this contains malicious JavaScript content. (For related eBay policy, see http://pages.ebay.com/help/policies/listing-javascript.html.) The Description field is required for all listings, except certain listings that include Pre-filled Item Information. (See "About the Pre- filled Item Information API." in the eBay Web Services Guide.) Even if your application does not support listings items with Pre-filled Item Information, you should be aware that this also means GetItem, GetSellerList, and GetBidderList may return some items with empty Description fields. If you embed pictures in the description (by using IMG tags) instead of using PictureURL, but you want a camera icon to appear in search and listing pages, specify the following null-image URL in PictureURL: http://pics.ebay.com/aw/pics/dot_clear.gif. See "Including Pictures in an Item Listing" in the eBay Web Services Guide. For eBay Live Auctions listings, JavaScript is not allowed. Not applicable to Half.com. (For Half.com, use AttributeArray.Attribute with attributeLabel="Notes" to specify a brief description or note to the buyer.) 500000 (some sites may allow more, but the exact number may vary) AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally GetBidderList Conditionally GetItem ItemReturnDescription, ReturnAll Always The distance used in a proximity search distance calculation. Not applicable to Half.com. GetSearchResults GetCategoryListings Conditionally Specifies a promotional offer that allow the buyer to purchase items on credit. You can call GetFinanceOffers to retrieve the current set of valid offers that can be specified for items. If specified, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods). Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally If set, a generic gift icon displays next the listing's title in search and browse pages. GiftIcon must be set to be able to use GiftServices options. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetSellerList ItemReturnDescription, ReturnAll Conditionally Optional gift services that the seller is offering if the buyer chooses to purchase the item as a gift. Only returned if offered by the seller. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Conditionally GetItem 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. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetSellerList ItemReturnDescription, ReturnAll Conditionally (in/out) The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResultsExpress, always returned when ItemArray.Item is returned. 19. (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits.) AddOrder GetBestOffers RelistItem ReviseItem ReviseLiveAuctionItem Yes GetItemRecommendations Conditionally GetBidderList GetDispute GetOrders Always GetOrderTransactions none Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Always GetOrderTransactions none Always GetBestOffers GetItemsAwaitingFeedback GetMemberMessages GetSearchResults GetSearchResultsExpress Conditionally GetUserDisputes ReturnSummary, ReturnAll, none Conditionally GetMyeBayBuying BestOfferList BidList LostList SecondChanceOffer WatchList WonList none, ReturnSummary, ReturnAll Conditionally GetMyeBaySelling ActiveList ScheduledList Transaction UnsoldList Conditionally GetSellerEvents none, ReturnAll Conditionally GetSellerEvents none, ReturnAll Conditionally GetSearchResultsExpress Always GetSellerList none, ItemReturnDescription, ReturnAll 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. Not applicable to Half.com. GetBestOffers GetBidderList GetDispute GetMyeBay Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetItemTransactions GetSellerTransactions ItemReturnDescription, ReturnAll Always GetOrderTransactions none Always GetSellerEvents none, ReturnAll Conditionally GetCategoryListings GetItemsAwaitingFeedback GetMemberMessages GetSearchResults Conditionally GetMyeBayBuying BestOfferList BidList LostList SecondChanceOffer WatchList WonList none, ReturnSummary, ReturnAll Conditionally GetMyeBaySelling ActiveList ScheduledList Transaction UnsoldList Conditionally GetSellerList none, ItemReturnDescription, ReturnAll Conditionally AddItem GetItemRecommendations ReviseItem RelistItem VerifyAddItem 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. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetMyeBay Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItem ItemReturnDescription, ReturnAll Conditionally Describes the number of days the seller wants the listing to be active (available for bidding/buying). The valid choice of values depends on the listing type. The duration specifies the seller's initial intent at listing time. If the listing ends early, the value of the listing duration does not change. The end time for an auction is calculated by adding the duration to the item's start time. When a listing's duration is changed, any related fees (e.g., 10-day fee) may be debited or credited (as applicable). 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 can change 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. For a list of valid values that you can cache for future use, call GetCategoryFeatures with DetailLevel set to ReturnAll and look for ListingDuration results. Also required to Half.com (but only specify GTC). AddItem VerifyAddItem Yes GetItemRecommendations RelistItem ReviseItem No GetBidderList GetSearchResults Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetMyeBaySelling ScheduledList Conditionally Describes listing upgrades that sellers can select for a fee, such as the BoldTitle upgrade. Also includes feature packs for saving on listing upgrades. See <a href="http://pages.ebay.com/help/sell/ia/promoting_your_item.html">Listing Upgrades</a> in the eBay Web site online help. You cannot remove listing upgrades when you revise a listing. For AddLiveAuctionItem and ReviseLiveAuctionItem, you can specify a maximum of 10 featured lot items per live auction catalog. Not applicable to Half.com. AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No GetSellerList ItemReturnDescription, ReturnAll Conditionally GetBidderList GetCategoryListings GetMyeBay GetSearchResults Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally Indicates the format of the listing the seller wants to use, such as Chinese auction or fixed price. See Different Ways of Selling in the eBay online help: http://pages.ebay.com/help/sell/ia/formats.html Also see Listing Types in the eBay Web Services guide. You cannot modify the listing type of an active listing. Optional for eBay.com listings (defaults to Chinese). Required for Half.com listings (and the value must be Half). Required for Express format listings on Express Germany (and the value must be Express). Eligible items listed in the fixed price or Store Inventory format on the US or Germany site are also included on eBay Express. See "eBay Express" in the eBay Web Services guide for more information about listing on Express. AddItem GetItemRecommendations RelistItem VerifyAddItem Conditionally GetBidderList GetMyeBay Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Always GetOrderTransactions none Always GetCategoryListings GetSearchResults Conditionally GetMyeBaySelling ActiveList ScheduledList Transaction UnsoldList Conditionally GetSellerEvents ReturnAll Conditionally Reserved for future use. AddItem RelistItem ReviseItem No GetItem Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally Indicates the geographical location of the item (along with Country). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. Also applicable as input to AddItem and related calls when you list items to Half.com. 45 AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetSellerList ItemReturnDescription, ReturnAll Conditionally GetCategoryListings Conditionally A lot is a set of two or more similar items that must be purchased together in a single transaction. A listing can have multiple lots (instead of multiple items). When LotSize is specified, the listing price reflects the price of each lot (not each item within the lot). In this case, Quantity indicates the number of lots being listed, and LotSize indicates the number of items in each lot. (If a listing has no lots, Quantity indicates the number of separate items being listed.) Important: Lot items can be listed only in lot-enabled categories. GetCategories returns LSD (lot size disabled) with a value of true for categories that do not support lots. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem Conditionally GetItemTransactions GetSellerTransactions ReturnAll Conditionally GetOrderTransactions none Conditionally If true in listing requests and responses, the item is listed with Now and New. Only applicable to Buy It Now, fixed-price, and Store Inventory listings on certain eBay sites. See the eBay Web Services guide for details. In requests that list items, only valid if the seller also specifies the item condition (as new), predefined return policy attributes, a buy it now or fixed price, and shipping costs. To remove Now and New from a listing, set the value to false. If the listing has bids (or items have been sold) or the listing ends within 12 hours, you cannot add or remove NowAndNew when you revise the listing. Not applicable to Half.com. AddItem GetItemRecommendations ReviseItem RelistItem VerifyAddItem No GetBidderList GetItem Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItemTransactions GetSellerTransactions ReturnAll Conditionally GetOrderTransactions none Conditionally Not currently operational. Not currently operational. Identifies the payment method (such as credit card or PayPal) the seller will accept for the buyer to pay for the purchase of the item. If you specify multiple PaymentMethods fields, the repeating fields must be contiguous. For example, you can specify PayPalEmailAddress after a list of repeating PaymentMethods fields, but not between them: <PaymentMethods>AmEx</PaymentMethods> <PaymentMethods>PersonalCheck</PaymentMethods> <PaymentMethods>PayPal</PaymentMethods> <PayPalEmailAddress>mypaypalemail@ebay.com</PayPalEmailAddress> In general, if you separate repeating instances of a field, the results will be unpredictable. This rule applies to all repeating fields (maxOccurs="unbounded" or greater than 1) in the schema. See "Overview of the Schema" in the eBay Web Services guide. A listing must have at least one valid payment method. When you revise or relist an item and you specify a payment method that is invalid for the target site, eBay ignores the invalid payment method, applies the other valid changes, and returns a warning to indicate that the invalid payment method was ignored. If multiple payment methods were invalid, the warning indicates that they were all ignored. If you modify the listing so that it includes no valid payment methods, an error is returned. This situation could occur when the seller removes all valid payment methods or when all the payment methods specified for the item are no longer valid on the target site. For a listing to be eligible for Express US, PayPal is a required payment method. For Express Germany, Express format listings must include PayPal, but fixed-price and Store Inventory listings do not require PayPal (as long as a default PayPal account is specified in the seller's Express preferences). See eBay Express information in the eBay Web Services Guide. Payment methods are not applicable to eBay Real Estate ad format listings or Half.com. Listing an Item http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem (SetUserPreferences) SellerPaymentPreferences io_SetUserPreferences.html#Request.SellerPaymentPreferences Accept PayPal as a Payment Method http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressPaymentMethods Overview of the XML API Schema http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SchemaOverview AddItem VerifyAddItem Yes GetItemRecommendations RelistItem ReviseItem Conditionally GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetItemTransactions GetSellerTransactions none, ReturnAll Always GetOrderTransactions none Always GetSellerList ItemReturnDescription, ReturnAll Conditionally GetCategoryListings GetMyeBay GetSearchResults 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.) Required if seller has chosen PayPal as a payment method (PaymentMethods) for the listing. For a listing to be eligible for Express US, the seller needs to use an email address that is in good standing and that is associated with a PayPal Premier or PayPal business account that is set to ship to unconfirmed addresses. For Express Germany, PayPalEmailAddress must be specified for Express format listings, but it is optional for fixed-price and Store Inventory listings (as long as an eligible default PayPal account is specified in the seller's Express preferences). If the specified PayPal account becomes ineligible for eBay Express payments (because the seller blocked unconfirmed addresses or some other change occurred), the items associated with that account may become ineligible for Express and may no longer appear on Express. See eBay Express information in the eBay Web Services Guide for more information. For digital listings, the seller needs to use an email address that is associated with a PayPal Premier or PayPal business account. To remove this value when you revise or relist an item, use DeletedField. When you revise a listing, if the listing has bids (or items have been sold) or it ends within 12 hours, you can add PayPalEmailAddress, but you cannot remove it. Not applicable to eBay Motors listings. Also not applicable to Half.com. Listing an Item http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem Accept PayPal as a Payment Method http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressPaymentMethods (SetUserPreferences) SellerPaymentPreferences io_SetUserPreferences.html#Request.SellerPaymentPreferences (SetUserPreferences) ExpressPreferences.DefaultPayPalAccount io_SetUserPreferences.html#Request.ExpressPreferences.DefaultPayPalAccount AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally Category ID for the first (or only) category in which the item is listed (or is to be listed in the case of new, as-yet unlisted items). Use calls like GetCategories and GetCategoryFeatures to determine valid values for the site on which you are listing (see the eBay Web Services Guide for information on working with categories). Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill. Most eBay.com categories are also eligible for eBay Express. Categories not covered by PayPal Buyer Protection are excluded. Also, certain categories that do not support item condition may be excluded. See "eBay Express" in the eBay Web Services Guide. When revising a listing, you can change the primary category only if an item has no bids (or no items have sold) and the listing does not end within 12 hours. If you change the listing category, any Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the new category. In that case, if you still want to include Item Specifics, you need to specify attributes that are appropriate for the category. See Item.AttributeSetArray. You cannot change the meta-categories for vehicles (i.e., you cannot change a truck to a motorcycle), but you can change the leaf category (e.g., change one motorcycle subcategory to another motorcycle subcategory). See the eBay Web Services Guide for additional rules. International sites (such as the eBay Germany site) have similar rules for revising vehicle categories. For eBay Live Auctions (e.g., in AddLiveAuctionItem), this is the eBay Live Auctions site category in which to list the item. This can be different from the category that is associated with the seller's catalog. See Specifying eBay Live Auctions Categories in the eBay Web Services guide. For GetItemRecommendations, use this to control the category that will be searched for recommendations. Specify the category in which the item will be listed. See the eBay Web Services guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attributes engine. Not applicable to Half.com. Categories http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryOverview Specifying eBay Live Auctions Categories http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=LiveAuctionCategories AddItem AddLiveAuctionItem GetItemRecommendations VerifyAddItem Yes GetItemRecommendations Conditionally RelistItem ReviseItem ReviseLiveAuctionItem No GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetItemTransactions GetSellerTransactions ReturnAll Always GetOrderTransactions none Always GetSellerList ItemReturnDescription, ReturnAll Conditionally GetMyeBay Conditionally If true, designates the listing as a private auction. The list of bidders on private auctions is hidden when the active listing is viewed. Sellers may want to use this option when they believe that potential bidders for a listing would not want their User IDs disclosed to others. Not applicable to Half.com. AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Always GetOrderTransactions none Always GetSellerList ItemReturnDescription, ReturnAll Conditionally Specifies stock product information to include in a listing. Only applicable when listing items with Pre-filled Item Information. If the item's primary and secondary category are both catalog-enabled, the product listing details must be applicable to the primary category. If only one category is catalog- enabled, the product listing details must be applicable to the catalog-enabled category. Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem request, but not both. See the eBay Web Services Guide for information on listing with Pre-filled Item Information. If a listing includes Pre-filled Item Information and you change a category, the rules for continuing to include Pre-filled Item Information depend on whether or not the new category is mapped to a characteristic set associated with the same product ID. When you revise a listing, if it has bids or it ends within 12 hours, you cannot change the product ID and you cannot remove existing product data. However, you can change or add preferences such as IncludeStockPhotoURL, UseStockPhotoURLAsGallery, and IncludePrefilledItemInformation. To delete all catalog data when you revise or relist an item, specify Item.ProductListingDetails in DeletedField and don't pass ProductListingDetails in the request. For GetItemRecommendations, see the eBay Web Services guide for differences in validation rules when using the Product Pricing engine. Not applicable to Half.com. AddItem RelistItem ReviseItem VerifyAddItem No GetItemRecommendations Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally GetBidderList Conditionally GetItem ItemReturnAttributes, ReturnAll Conditionally Proximity search information for the item. This response type is deprecated and may be removed from the schema in a future release. Remove application dependencies on this type. For item location, refer to Item.PostalCode instead. Not applicable to Half.com. GetBidderList Always Deprecated GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always Deprecated GetSellerList ItemReturnDescription, ReturnAll Conditionally Deprecated For AddItem and related calls, this is the number of items in the listing. For new listings being defined, this is the initial number of items the seller offers for sale. Even during a Dutch auction, where one of several items can be purchased during the auction, this number does not change. Sellers need to meet certain feedback requirements to specify a quantity greater than 1. When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller. For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. AddItem RelistItem VerifyAddItem Yes GetItemRecommendations ReviseItem No GetBidderList GetDispute Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetItemTransactions GetSellerTransactions ReturnAll Always GetOrderTransactions none Always GetSellerList ItemReturnDescription, ReturnAll Conditionally GetMyeBay Conditionally GetMyeBaySelling ActiveList ScheduledList UnsoldList Conditionally GetSellerEvents none, ReturnAll Conditionally GetSellerEvents none, ReturnAll Conditionally Not supported as input in listing calls. Use SetUserNotes instead A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) AddItem GetItemRecommendations RelistItem VerifyAddItem ReviseItem Obsolete No GetOrders Conditionally GetOrderTransactions none Conditionally This field is used by the China site only. On all other sites, the use of regions for locating items has been replaced by distance-based searching and searches by location name. For sites that no longer support the use of regions, use Item.PostalCode and Item.Location instead. GetItem Conditionally 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. GetBidderList GetItem Conditionally The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support reserve prices. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the eBay Web Services guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. For more information on reserve price auctions, see http://pages.ebay.com/help/sell/reserve.html. 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 (http://pages.ebay.com/help/sell/fees.html) for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the eBay Web Services guide for validation rules when revising US Motors listings. For AddLiveAuctionItem and ReviseLiveAuctionItem, the seller needs to make sure they specify the amount in the currency selected for the live auction event. When you revise a Live Auction item, you can lower an existing reserve price, but you cannot add a reserve price or remove an existing reserve price if the item has absentee bids or ends in less than 12 hours. Not applicable to Half.com. 16 AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No GetBidderList Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetMyeBaySelling ActiveList ScheduledList SoldList UnsoldList Conditionally Indicates whether an item has been revised since the listing became active and, if so, which among a subset of properties have been changed by the revision. Output only. Not applicable to Half.com. GetSellerList ItemReturnDescription, ReturnAll Conditionally GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always Allows a user to schedule a listing to start at the specified time in the future. Specify the time (in GMT) that the item's listing is scheduled to be active on eBay. Input only. For ReviseItem, you can modify this value if the current schedule time is in the future. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem Conditionally ID for second category in which the item is listed (also see Item.PrimaryCategory). Listing an item in a second category is optional. Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill. Not applicable to eBay China (site 223). Not applicable to Half.com. Most eBay.com categories are also eligible for eBay Express. Categories not covered by PayPal Buyer Protection are excluded. Also, certain categories that do not support item condition may be excluded. See "eBay Express" in the eBay Web Services Guide. When revising a listing, you can add, remove, or change the secondary category only if the listing has no bids (or no items have sold) and it does not end within 12 hours. If you change the secondary category, any corresponding Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the category. In that case, if you still want to include Item Specifics, you need to specify attributes that are valid for the category. See Item.AttributeSetArray. You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. Furthermore, as of June 2006, 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. 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. The Final Value Fee is based on the primary category in which the item is listed. For eBay Live Auctions (e.g., AddLiveAuctionItem), this is the eBay US site category in which to list the item. (This can be any eBay US category except Motors or Real Estate categories.) Note that eBay Live Auctions does not charge a fee to specify an eBay category (i.e., no List in Two Category fees). See Specifying eBay Live Auctions Categories in the eBay Web Services guide. In AddLiveAuctionItem, you need to specify SecondaryCategory if you are including Item Specifics (AttributeSetArray). For eBay Live Auctions, you can add SecondaryCategory when you revise the lot item, but you cannot change or remove an existing secondary category if the item has absentee bids or it ends in less than 12 hours. For GetItemRecommendataions, use this to control the category that will be searched for recommendations. Specify the category in which the item will be listed. See the eBay Web Services guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attributes engine. 10 AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No GetBidderList GetSearchResults Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetItemTransactions GetSellerTransactions ReturnAll Conditionally GetOrderTransactions none Conditionally GetSellerList 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. Not applicable to Half.com. GetBidderList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally Deprecated in the response with compatibility level 439 and higher. PictureDetails returned instead. Applications should remove dependencies on SiteHostedPicture: SiteHostedPicture contains the data for pictures associated with an item, when those pictures are hosted on the eBay site (eBay Picture Services). The similar element, VendorHostedPicture, contains the data for pictures hosted somewhere other than on the eBay site. Both SiteHostedPicture and VendorHostedPicture are being phased out and may be removed in a future release. Applications should use PictureDetails instead. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails will take precedence. For a listing to be eligible for eBay Express, it must include a picture, gallery, or stock photo URL. Some categories are exempt from this requirement. See "eBay Express" in the eBay Web Services Guide. Not applicable to Half.com. AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem Conditionally Deprecated GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally Deprecated GetMyeBayBuying Deprecated BidList SecondChanceOffer none, ReturnSummary, ReturnAll Conditionally GetItem Deprecated none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetItem Deprecated none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally Container for information about this listing's seller. Not applicable to Half.com. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally GetCategoryListings GetSearchResults Conditionally GetMyeBayBuying BestOfferList BidList LostList WatchList WonList none, ReturnSummary, ReturnAll Conditionally GetCategoryListings GetSearchResults Conditionally GetSearchResultsExpress Conditionally AddItem ReviseItem VerifyAddItem Conditionally Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. For GetSearchResultsExpress, this is always returned when ItemArray.Item is returned. GetBidderList GetDispute Always GetSellerEvents none, ReturnAll Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetItemTransactions GetSellerTransactions none, ReturnAll Always GetOrderTransactions none Always GetSellerList ItemReturnDescription, ReturnAll Conditionally GetCategoryListings GetMemberMessages GetSearchResults Conditionally GetMyeBayBuying BestOfferList BidList LostList WatchList WonList none, ReturnSummary, ReturnAll Conditionally GetMyeBaySelling ActiveList SoldList UnsoldList Conditionally GetSellerEvents none, ReturnAll Conditionally GetSearchResultsExpress Conditionally Indicates where the seller is willing to ship the item. Default is SiteOnly. See ShippingOptionCodeType for specific values. If SitePlusRegions is selected, when the item is listed, then at least one region must also be specified (in ShippingRegions). Obsolete with compatibility level 383 and higher. Use Item.ShipToLocations instead. Not applicable to Half.com. AddItem RelistItem ReviseItem VerifyAddItem No Obsolete The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. For a listing to be eligible for eBay Express, shipping details are required to support the eBay Express shopping cart. For flat shipping, this means the shipping service and cost are required. For calculated shipping, all of the usual parameters (weight, originating postal code, etc.) are required. See "eBay Express" in the eBay Web Services Guide. In GetSearchResultsExpress, always returned when ItemArray.Item is returned. Shipping details are not applicable to Real Estate listings and Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally GetBidderList GetSearchResults Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetMyeBayBuying BidList none, ReturnSummary, ReturnAll Conditionally GetMyeBaySelling ScheduledList Conditionally GetSearchResultsExpress Always Indicates the global regions to which the seller is willing to ship the item(s). Only applicable if the seller specifies SitePlusRegions for the shipping option (ShippingOptionCodeType). See ShippingRegionCodeType for specific shipping regions values. Obsolete with compatibility level 373 and higher. Use Item.ShipToLocations instead. Not applicable to Half.com. AddItem RelistItem ReviseItem VerifyAddItem No Obsolete Indicates who pays the shipping costs for the item(s), the buyer or the seller. Deprecated with compatibility level less than 309 and obsolete with compatibility level 309 or higher. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Obsolete No An international location or region to which the seller is willing to ship, regardless of shipping service. The country of the listing site is added by eBay. Use GeteBayDetails with a DetailName of ShippingLocationDetails to determine which international locations are valid for the site. Omit ShipToLocations if you want to ship only within the country of the listing site. To state that you do not wish to ship at all, set ShipToLocations to None. ReviseItem can add a ShipToLocation. Applicable with compatibility level 373 and higher. Not applicable to Half.com. length of longest name in ShippingRegionCodeType and CountryCodeType AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetSellerList ItemReturnDescription, ReturnAll Conditionally ShipToLocation: Two Types, Two Meanings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShipToLocation The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases (such as with listings on eBay Express), the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing. When you specify Item.Site in AddItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API). Not applicable to Half.com. For eBay Live Auctions, pass a value of US. AddItem AddLiveAuctionItem GetItemRecommendations VerifyAddItem Yes GetBidderList GetDispute Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetItemTransactions GetSellerTransactions ReturnAll Conditionally GetCategoryListings Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally GetMyeBayBuying BestOfferList BidList LostList SecondChanceOffer WatchList WonList none, ReturnSummary, ReturnAll Conditionally GetSellerEvents none, ReturnAll Conditionally (in/out) The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price. For auction-type listings, competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For fixed-price listings (FixedPriceItem), Store Inventory (StoresFixedPrice) listings, and Express format listings, this is the constant price at which a buyer may purchase the item. For a listing to be eligible for Express, the max start price is USD 10,000.00 for the US and EUR 10000 for Germany. (Additional price limits may be imposed by the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation, as they may vary for each user.) Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. For eBay Live Auctions items, this is the amount at which absentee Internet bidding for the item begins. Maximum length 16. Must be greater than zero. The seller needs to make sure they specify the amount in the currency selected for the live auction event. AddItem AddLiveAuctionItem VerifyAddItem Yes GetItemRecommendations ReviseItem RelistItem No GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetMyeBayBuying BidList LostList WatchList WonList none, ReturnSummary, ReturnAll Conditionally GetMyeBaySelling ActiveList ScheduledList SoldList UnsoldList Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItemTransactions GetSellerTransactions ReturnAll Conditionally GetOrderTransactions none Conditionally Contains information related to the item in the context of a seller's eBay Store. Applicable for auction formats, Basic Fixed Price, and Store Inventory format items listed by eBay Stores sellers. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetSearchResults Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetSellerList ItemReturnDescription, ReturnAll 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). 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. (Other US and CA eBay Motors categories support this field as of December 2005.) For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle. Not applicable to Half.com. When you revise a item, you can add or change the subtitle, but you cannot remove it. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine and a subtitle was specified for the item. 55 AddItem RelistItem AddLiveAuctionItem GetItemRecommendations ReviseItem ReviseLiveAuctionItem VerifyAddItem No GetBidderList GetCategoryListings Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetSearchResultsExpress Conditionally Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the eBay Web Services guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com. GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetMyeBayBuying BestOfferList BidList SecondChanceOffer Conditionally none, ReturnSummary, ReturnAll WatchList GetMyeBaySelling ActiveList Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally Name of the item as it appears in the listing or the Gallery. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre- filled based on the catalog product title). You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetSearchResultsExpress, always returned when ItemArray.Item is returned. 55 AddItem AddLiveAuctionItem GetItemRecommendations VerifyAddItem Conditionally RelistItem ReviseItem No GetSellerList ItemReturnDescription, ReturnAll Conditionally GetCategoryListings GetItemsAwaitingFeedback GetMemberMessages GetSearchResults ReviseLiveAuctionItem Conditionally GetItemTransactions GetSellerTransactions ReturnAll Conditionally GetOrderTransactions none Conditionally GetMyeBayBuying BestOfferList BidList LostList SecondChanceOffer WatchList WonList none, ReturnSummary, ReturnAll Conditionally GetMyeBaySelling ActiveList ScheduledList SoldList UnsoldList Conditionally GetBidderList GetDispute GetOrders Always GetOrderTransactions none Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetItemTransactions GetSellerTransactions ReturnAll Conditionally GetOrderTransactions none Conditionally GetSearchResultsExpress Always GetSellerEvents none, ReturnAll Conditionally We recommend that you use InvocationID instead of Item.UUID. InvocationID provides more flexibility than UUID. 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. 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 categories that are children of the same meta-category (i.e., within the hierarchy of each level-1 category). UUID is not applicable to ReviseItem (because you are modifying an existing item, not creating a new one.) Also applicable as input to AddItem and related calls when you list items to Half.com. 32 AddItem AddLiveAuctionItem RelistItem ReviseLiveAuctionItem VerifyAddItem No GetBidderList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally Container for eBay's Business User 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). Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList GetItem Conditionally Deprecated in the response with compatibility level 439 and higher. PictureDetails returned instead. Applications should remove dependencies on VendorHostedPicture: VendorHostedPicture contains the data for a picture associated with an item, when that picture is hosted on a site of the seller's choice (other than on the eBay site with eBay Picture Services). The similar element, SiteHostedPicture, contains the data for pictures hosted on the eBay site. Both SiteHostedPicture and VendorHostedPicture are being phased out and may be removed in a future release. Applications should use PictureDetails instead. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails will take precedence. For a listing to be eligible for eBay Express, it must include a picture, gallery, or stock photo URL. Some categories are exempt from this requirement. See "eBay Express" in the eBay Web Services Guide. Not applicable to Half.com. AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No Deprecated GetSellerList ItemReturnDescription, ReturnAll Conditionally Deprecated GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally Deprecated GetMyeBayBuying BidList SecondChanceOffer Deprecated none, ReturnSummary, ReturnAll Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally The seller is on vacation (as determined by the seller's store preferences) in two cases: i.) the item is a Store Inventory item and the seller has chosen to hide Store Inventory items while on vacation, and ii.) the seller has chosen to add a message to listed items while on vacation. Not applicable to Half.com. GetBidderList GetItem Conditionally GetSellerEvents ReturnAll Conditionally The number of watches placed on this item from buyers' My eBay accounts. Not applicable to Half.com. GetBidderList GetItem Conditionally GetSellerEvents ReturnAll Conditionally GetSellerEvents ReturnAll 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 none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally If false (or omitted): if BuyerRequirements is present, its requirements are to be used; otherwise, any requirements specified in My eBay are to be used. If true: no requirements are considered from any source (and if BuyerRequirements is present, it is ignored). false AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetSellerList ItemReturnDescription, ReturnAll Conditionally GetBidderList GetItem Conditionally Container for buyer requirements. Individual buyer requirements cannot be modified or added. The call needs to provide the entire set of buyer requirements to modify or add any. This is only returned if the caller is the seller. See also the eBay Web site help regarding <a target="_blank" href="http://pages.ebay.com/help/sell/buyer-requirements.html">Selecting Buyer Requirements</a>. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally Container for BestOffer properties associated with the item. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetSellerEvents none, ReturnAll Conditionally GetMyeBayBuying Conditionally BestOfferList none, ReturnSummary, ReturnAll Whether the seller is offering Anything Points for the item. Not applicable to Half.com. GetBidderList Always GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always GetSellerList ItemReturnDescription, ReturnAll Conditionally Describes the live auction-specific details of a lot item. Applicable to eBay Live Auctions only. AddLiveAuctionItem ReviseLiveAuctionItem Yes True if eBay provided a central location as a result of the user not specifying a location. Not applicable to Half.com. GetBidderList GetItem Conditionally Whether checkout for this is to be handled by a Third-Party Checkout application. Only for authorized Third-Party Checkout applications. See "Third-Party Checkout" in the main documentation. For a listing to be eligible to appear on eBay Express, you also need to agree to use a Platform Notification (or transaction calls) instead of Third-Party Checkout to process Express sales. To do this, specify ThirdPartyCheckoutIntegration with a value of true. IMPORTANT: If you are not authorized to support Third Party Checkout and your application is not the original listing application, never specify ThirdPartyCheckout or ThirdPartyCheckoutIntegration in your request (even if you revise a listing that already includes these flags). Otherwise, the listing may be dropped from Express or you may get unexpected results. See "eBay Express" in the eBay Web Services Guide. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally Third Party Checkout http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ThirdPartyCheckout Indicates whether the seller's tax table is to be used when applying and calculating taxes. If true, a tax table must exist for the seller, and the following tags should not be used: SalesTaxState, SalesTaxPercent, ShippingIncludedInTax. If the seller wants to charge sales tax for eBay Express sales, the seller needs to create a tax table on eBay and use it for their listings. As eBay Express payments are handled via a shopping cart, you will not be able to calculate and add sales tax during your own checkout flow. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No eBay Express http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=eBayExpress Enabling Multi-jurisdiction Sales Tax http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SalesTax Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetSellerList ItemReturnDescription, ReturnAll Conditionally GetBidderList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetItemTransactions GetSellerTransactions ReturnAll Conditionally GetOrderTransactions none Conditionally Enabling Multi-jurisdiction Sales Tax http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SalesTax 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 ShippingOption or ShippingDetails.ShippingServiceOptions for vehicle listings. If true and the listing is on the US eBay Motors site, and you want the listing to be visible on the eBay Canada site, set Item.ShipToLocations to CA. If true and the listing is on the eBay Canada site , and you want your listing to be visible on the US eBay Motors site, set Item.ShipToLocations to US. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally Applicable to US eBay Motors vehicle listings only. If false, the vehicle will not be considered for a limited warranty by eBay. If your application lists Motors vehicles, you must provide the seller with an opportunity to indicate whether the vehicle has not been modified and is not a special type (e.g., Corvette ZR1). If LimitedWarrantyEligible is passed in, it means the application has presented the seller with checkboxes to indicate this information. If true, the seller has verified that the vehicle has not been modified and is not a special type. If false, the seller has verified that vehicle has been modified or it is a special type. Passing a value of true does not guarantee that eBay will offer a limited warranty. It only makes the listing eligible for consideration. See the eBay Web Services Guide for more information about Motors vehicle listings. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally Returns a note from eBay displayed below items in the user's My eBay account. Not applicable to Half.com. GetMyeBayBuying none, ReturnSummary, ReturnAll Conditionally Specifies the number of questions buyers have posted about the item. 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. GetMyeBaySelling Conditionally GetBidderList GetItem Conditionally Specifies how many of a certain item are available. Not applicable to Half.com. For GetSearchResultsExpress, only returned when ItemDetails is set to Fine. GetMyeBayBuying BidList WatchList none, ReturnSummary, ReturnAll Conditionally GetMyeBaySelling ActiveList UnsoldList Conditionally GetSearchResultsExpress Conditionally This element is a SKU (stock-keeping unit) defined by a seller. The seller can use a SKU to identify one item or use the same SKU for multiple items. Preferable to ApplicationData for SKUs and inventory tracking. Different sellers can use the same SKUs. This element can be used by sellers to track complex flows of products and information. This element preserves a SKU, enabling a seller to obtain it before and after a transaction is created. To remove a SKU when you revise or relist an item, use DeletedField. Not applicable to Half.com. 50 AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetSellerList ItemReturnDescription, ReturnAll Conditionally GetBidderList GetItem GetOrders Conditionally GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally GetOrderTransactions none Conditionally Allows eBay to auto-fill some of a listing's Item Specifics (attribute) values based on the listing's category (or categories). Auto-filling attributes based on a category is not the same as using Pre-filled Item Information based on a catalog product (see ProductListingDetails). If true, also specify Item.CategoryMappingAllowed with a value of true. (Alternatively, you can auto-fill attributes on the client side by using mapping meta-data returned by GetAttributesCS.) See the eBay Web Services guide for more information. Ignored if the category does not support auto-filling attributes. If you also pass in attributes in AttributeSetArray, your values will override any auto-filled values for the same attributes. Once you have overridden the value of an auto-filled attribute for a given listing, eBay will not auto-fill it on subsequent ReviseItem requests (even if you remove the overridden value). Not applicable to Half.com. AddItem GetItemRecommendations ReviseItem RelistItem VerifyAddItem 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. Not applicable to Half.com. GetSearchResults Conditionally Postal code of the place where the item is located. This value is used for proximity searches. Not applicable to Half.com. AddItem GetItemRecommendations ReviseItem RelistItem VerifyAddItem No GetBidderList GetSearchResults Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Always Indicates whether details about shipping costs and arrangements are specified in the item description. Not applicable to Half.com. AddItem GetItemRecommendations ReviseItem RelistItem VerifyAddItem No GetSellerList ItemReturnDescription, ReturnAll Conditionally GetBidderList Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally Causes eBay to list the item with Pre-filled Item Information based on an ISBN value, UPC value, EAN value, ticket keywords, or eBay catalog product ID, plus other meta-data that you specify. Only applicable for certain categories. See the eBay Web Services Guide for information on the categories that currently support usage of this field. If you are listing in a media category and the primary and secondary category are both catalog-enabled, the external ID must be for a product associated with the primary category. If only one category is catalog-enabled, this external ID must be for a product that is associated with the catalog-enabled category. If you are listing an event ticket, the external ID must be associated with the primary category. Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem (or VerifyAddItem) request. Do not specify both. ExternalProductID is not applicable when revising and relisting items (use Item.ProductListingDetails instead). If you use Item.ExternalProductID instead of Item.ProductListingDetails, eBay sets IncludeStockPhotoURL and UseStockPhotoAsGallery to true automatically. The stock photo URL satisfies the eBay Express picture requirement. See "eBay Express" in the eBay Web Services Guide. In GetItemRecommendations, only applicable when the value of ListingFlow is AddItem. Not applicable when the recommendation engine is ProductPricing. Optional for eBay.com listings. Not applicable as input to AddItem for Half.com listings. (Use ExternalProductID at the root level of the AddItem request instead for Half.com listings.) AddItem 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. Not applicable to eBay.com listings. 100 AddItem GetItemRecommendations VerifyAddItem ReviseItem No GetBidderList GetItem GetOrders Conditionally GetOrderTransactions none Conditionally Contains the data for a picture associated with an item. Replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with compatibility level 439 or greater. With the future deprecation of SiteHostedPicture and VendorHostedPicture in the input, applications should use PictureDetails in the input as well. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails will take precedence. For a listing to be eligible for eBay Express, it must include a picture, gallery, or stock photo URL. Some categories are exempt from this requirement. See "eBay Express" in the eBay Web Services Guide. Not applicable to Half.com. AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No GetBidderList GetCategoryListings GetSearchResults Conditionally GetMyeBayBuying BidList SecondChanceOffer none, ReturnSummary, ReturnAll Conditionally GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally Indicates that the listing is a digitally delivered item. For listing calls, specifies information about the file and how it is delivered. By specifying the digital delivery fields, the seller agrees that they are the legal rights owner of this digital item or they have been authorized by the rights owner to sell this digital item. Transaction-retrieval calls like GetSellerTransactions return an (intentionally) empty DigitalDeliveryDetails node for digital listing purchases. (If the transaction is not for a digital listing, the node is not returned.) If you are listing in two categories and you specify this option, both categories must support digital listings. Call GetCategoryFeatures to determine which categories (if any) support digitally delivered goods. If a category supports this feature, it does not mean you are required to use this feature. (It only means that this feature is an option in that category.) If specified, the item must be sold at a fixed price (basic fixed price or Store Inventory), and the seller must require PayPal as the only payment method. The seller also needs to use a verified PayPal Premier or Business acount. On some sites, the seller must require Immediate Payment (see Item.AutoPay) unless the seller is using Third-Party Checkout. Some sites may require the seller to be VAT registered (see the eBay online help for requirements). For digital items, the Item Condition attribute (Item Specifics) is not applicable in AttributeSetArray, AttributeArray, or LookupAttributeArray. If you pass in the item condition, it will be dropped. Fields that specify the item location, shipping details, payment methods other than PayPal, gift options, Now and New, and Best Offer are not applicable to digitally delivered items. Digital listings are not eligible for eBay Express. When you revise or relist an item, if you change the listing format (e.g., to Chinese auction) or select a category that does not support this feature, eBay will remove the digital delivery option from the listing. As a result, you may need to specify different or additional information in the listing details. To remove DigitalDeliveryDetails when you modify a listing, use DeletedField. If any quantity of a multiple quantity digital delivery listing has been sold, the seller cannot remove the digital delivery option, edit the system requirements, or alter the delivery method information during the Revise flow. Not supported for Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetSellerList ItemReturnDescription, ReturnAll Conditionally GetBidderList GetCategoryListings GetItem GetSearchResults Conditionally GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions none Conditionally Specifies the maximum number of business days the seller commits to for shipping an item to domestic buyers after receiving a cleared payment. The seller sets this to an integer value (1, 2, 3, 4, 5, 10, 15, or 20) corresponding to the number of days. To add Get It Fast to listings, in addition to setting GetItFast to true, DispatchTimeMax must be set to 1 and the seller must specify at least one qualifying expedited shipping service. GetItem returns DispatchTimeMax only when shipping service options are specified for the item. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem Conditionally 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. AddItem RelistItem ReviseItem VerifyAddItem No GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItem 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. AddItem RelistItem ReviseItem VerifyAddItem No GetItem Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally Deprecated; use SkypeContactOption instead. If you use SkypeOption when adding an item, it is mapped to the corresponding values of SkypeContactOption. AddItem RelistItem ReviseItem VerifyAddItem No Deprecated GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItem Conditionally Deprecated Specifies the Skype contact options supported. Requires that SkypeEnabled is set to true. Available if the seller has a Skype account and has linked it (on the eBay site) with his or her eBay account. AddItem RelistItem ReviseItem VerifyAddItem No GetItem Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally Indicates, when true, that an item is available by Best Offer. GetSearchResults GetCategoryListings Conditionally Indicates, when true, that an item is available locally. GetSearchResults GetCategoryListings Conditionally Only authorized Third-Party Checkout providers can use this flag. IMPORTANT: If you are not authorized to support Third Party Checkout and your application is not the original listing application, never specify ThirdPartyCheckout or ThirdPartyCheckoutIntegration in your request (even if you revise a listing that already includes these flags). Otherwise, the listing may be dropped from Express or you may get unexpected results. A Third-Party Checkout provider uses this flag in two ways: 1) Set this flag to true to specify that you consent to use the Checkout notification (or calls like GetSellerTransactions and GetItemTransactions) to obtain data about eBay Express sales from the item, and to confirm that buyers will use the Express shopping cart for checkout processing without being redirected to your Third-Party Checkout site. If ThirdPartyCheckout is true, the ThirdPartyCheckoutIntegration field must also be true if you want an eligible listing to be included on eBay Express (and the Third Party Checkout checkout flow will be then be ignored for Express purchases). See "eBay Express" in the eBay Web Services Guide. In other words, assuming the seller and item meet all other eligibility requirements for Express, the seller opts into Express, and the seller (optionally) subscribes to the Checkout notification: - If ThirdPartyCheckout == true and ThirdPartyCheckoutIntegration == true, the item will be listed on Express and Checkout notifications will be sent. - If ThirdPartyCheckout == true and ThirdPartyCheckoutIntegration == omitted or false, the item will be disqualified for Express and no Checkout notification will be sent. - If ThirdPartyCheckout == omitted or false, and ThirdPartyCheckoutIntegration == true, the item will be listed on Express and Checkout notifications will be sent. - If ThirdPartyCheckout == omitted or false, and ThirdPartyCheckoutIntegration == omitted or false, the item will be listed on Express but no Checkout notifications will be sent. 2) If you subscribe to the Checkout notification, set this flag to true to enable Checkout notifications for a particular listing. These notifications can be sent for any transaction created from the listing, regardless of whether the listing is included on Express and regardless of the value of ThirdPartyCheckout. Checkout notifications are not sent if ThirdPartyCheckoutIntegration is false. Returned only if true for a listing. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No false GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItem Conditionally Listing Criteria for eBay Express http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressListingCriteria Third Party Checkout and eBay Express http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ThirdPartyCheckoutIntegration Preference to opt out an individual fixed price or Store Inventory item from eBay Express. Specify as input when listing an item to indicate that the item should not be listed on eBay Express. By default, an item is opted in unless the seller has configured their user preferences to opt all items out of Express (see GetUserPreferences). So, if the seller and item qualify for eBay Express, the item will be made available on the Express site unless you set this flag to true to opt out. ExpressOptOut has no effect if the seller opts out in their user preferences. Also, you cannot set ExpressOptOut to false to force an ineligible item to be included on Express. Coming soon: For Express Germany, this value is ignored for Express format listings. That is, sellers cannot opt out of Express when listing in the Express-only format. Listing Criteria for eBay Express http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressListingCriteria AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No false ProStores listing level preferences regarding the store to which checkout should be redirected for the listing if ThirdPartyCheckout is true. AddItem RelistItem ReviseItem VerifyAddItem Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally GetItem Conditionally Additional item details that only appear in eBay Express search results. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. GetSearchResultsExpress Conditionally Reserved for future use. AddItem ReviseItem VerifyAddItem RelistItem No GetItem Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally Reserved for future use. GetSellerList ItemReturnDescription, ReturnAll Conditionally Reserved for future use. GetItem Conditionally GetSellerList ItemReturnDescription, ReturnAll Conditionally ItemTypeFilterCodeType - Type declaration to be used by other schema. This code identifies the ItemTypeFilters (e.g., for GetSearchResults requests) used to filter items returned by the type of listing. (in) Only retrieve listings eligible for competitive bidding at auction. That is, only retrieve listings for which ListingType is Chinese, Dutch, or Live (regardless of the BuyItNowEnabled value). If a listing has a ListingType of any of the following, it is not retrieved: StoresFixedPrice, FixedPriceItem, and AdType. (in) Whether StoresFixedPrice items are retrieved depends on the site default. Only retrieves listings that can be purchased at a fixed price. That is, only retrieves listings for which ListingType is StoresFixedPrice or FixedPriceItemStore. Also retrieves Chinese and Dutch auction listings for which BuyItNowEnabled is true. Does not retrieve listings for which ListingType is AdType or Live, and does not retrieve auction listings for which BuyItNowEnabled is false. (in) It is recommended that you use AllItemTypes instead of AllItems. Return all listing types (the default for GetSearchResults). Whether StoresFixedPrice items are retrieved depends on the site default. (in) Only retrieve listings for which ListingType is StoresFixedPrice. (in) Exclude listings that have ListingType set to StoresFixedPrice. Exclude listings that have ListingType set to AdType or Live. Exclude auction listings in which BuyItNowEnabled is false. (in) Exclude listings that have ListingType set to StoresFixedPrice. (in) Retrieve listings whether or not ListingType is set to StoresFixedPrice; include auction items. (in) Retrieves fixed-price items. Whether StoresFixedPrice items are retrieved does not depend on the site default. Retrieves listings whether or not ListingType is set to StoresFixedPrice. Does not retrieve listings for which ListingType is AdType or Live. Does not retrieve auction listings for which BuyItNowEnabled is false. (out) Reserved for internal or future use. Reserved for future use. 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). The label to display when presenting the attribute to a user (e.g., "Title" or "Manufacturer"). The label is defined for the product, and is therefore not necessarily the same as the label that is defined in the characteristic set. GetProductFamilyMembers GetProductSearchPage GetProductSearchResults ReturnAll Always If true, the label name is visible on the eBay site. If false, the label is not visible. Usage of this information is optional. You are not required to display labels in the same manner as eBay. GetProductFamilyMembers GetProductSearchPage GetProductSearchResults ReturnAll Always (out) Contains results returned from the Listing Analyzer recommendation engine. (out) A collection of tips returned from the Listing Analyzer recommendation engine. GetItemRecommendations Conditionally ProStores listing level preferences. The name of the store, if Item.ThirdPartyCheckout is true. AddItem RelistItem ReviseItem VerifyAddItem Conditionally Contains the IDs for the Listing Designer theme and template (if either are used) associated with an item, which can optionally be used to enhance the appearance of the item's description. Cannot be used with Photo Display. With compatibility levels 439 or higher, specified in PictureDetails.PhotoDisplay. With lower compatibility levels, specified in SiteHostedPictureType.PhotoDisplay or VendorHostedPictureType.PhotoDisplay. Identifies the Layout template to use when displaying the item's description. When relisting an item, LayoutID is removed from the listing if you specify ListingDesignerType without LayoutID. Call GetDescriptionTemplates for valid IDs. Set to false in GetDescriptionTemplates (or do not specify LayoutID) to get the standard layout. If a Listing Designer layout is used (except standard layout), PhotoDisplayType must be false (or not be specified). AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetMyeBay Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItem Always ItemReturnDescription, ReturnAll If true, indicates that the item's picture will be enlarged to fit description of the item. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem GetMyeBay Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll ID for the Listing Designer theme template to use when displaying the item's description. When relisting, if you specify ListingDesignerType without ThemeID, ThemeID is removed from the listing. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetMyeBay Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItem Always ItemReturnDescription, ReturnAll Various details about a listing. Some of the details are calculated or derived after an item is listed. The details in this type include the start and end time and the converted (localized) prices. The details in this type also include input values applicable to the Best Offer feature. Additional details in this type include flags indicating if a seller specified fields whose values are not visible to the requesting user. (out) If true, the item is listed in a Mature category. Users must accept the Mature Category agreement on the eBay site to retrieve items listed in Mature categories. (Users do not need to sign this agreement to be able to list items in Mature Categories.) GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions Conditionally ReturnAll GetOrderTransactions none Conditionally (out) Applicable for Real Estate auctions only. If true, buyers and sellers are expected to follow through on the sale. If false, bids for the Real Estate auction are only expressions of interest. GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally ItemReturnDescription, ReturnAll (out) Indicates whether checkout is enabled for this item. If true, indicates that the seller elects to allow the item purchase to go through the checkout process, if the buyer chooses to do so. GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally ItemReturnDescription, ReturnAll Checkout http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Checkout (out) Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. GetCategoryListings Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetMyeBayBuying Conditionally SecondChanceOffer GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll (out) Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. GetMyeBay GetSearchResults Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions Conditionally ReturnAll GetOrderTransactions none Conditionally GetMyeBayBuying Conditionally WonList GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll (out) Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings. GetBidderList Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll (out) If true, the seller specified a value in ReservePrice. GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally ItemReturnDescription, ReturnAll GetMyeBayBuying Conditionally WonList (out) Obsolete: the use of regions for locating items is being phased out and has been replaced on most sites by distance-based searching and searches by location. Some sites, such as the China site, still use region. Although all sites will still allow you to specify Item.RegionID in AddItem when listing an item, only those sites that support the use of regions will return RegionName in the response for GetItem, and the region information will not appear on or be used by the web site. For sites that no longer support the use of regions, use Address.PostalCode and Item.Location instead. Obsolete Conditionally (out) Indicates the new item ID for a re-listed item. When an item is re-listed, the item ID for the new (re-list) item is added to the old (expired) listing to provide buyers a means to navigate to the new listing. This value only appears when the old listing is retrieved. Output only. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Conditionally ReturnAll GetOrderTransactions none Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll (out) The item ID for the original listing from which a second chance offer is made. This value is only returned when the data for the second chance offer listing is retrieved. Output only. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll (out) Time stamp (in GMT) that eBay recorded as the moment that the listing became available for bidding or buying. GetBidderList GetDispute Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Always ReturnAll GetOrderTransactions none Conditionally GetCategoryListings GetMemberMessages GetMyeBay GetSearchResults Conditionally GetSellerList Conditionally none, ItemReturnDescription, ReturnAll GetMyeBayBuying BestOfferList BidList LostList WatchList WonList Conditionally none, ReturnSummary, ReturnAll GetMyeBaySelling ActiveList ScheduledList Transaction UnsoldList Conditionally GetSellerEvents Conditionally none, ReturnAll (out) Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended. GetBidderList GetDispute GetMyeBay Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Always ReturnAll GetOrderTransactions none Conditionally GetSellerList Conditionally none, ItemReturnDescription, ReturnAll GetBestOffers GetCategoryListings GetItemsAwaitingFeedback GetMemberMessages GetSearchResults Conditionally GetMyeBayBuying Conditionally BidList LostList SecondChanceOffer WatchList WonList GetMyeBaySelling Conditionally Transaction UnsoldList GetSellerEvents Conditionally none, ReturnAll (out) The URL of the Web page where a user can view the listing. On the US site, this is called the "View Item" page. GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCategoryListings GetSearchResults Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll (out) Indicates whether the item has any unanswered questions. Use GetMemberMessages to retrieve unanswered questions for the item if this flag indicates that there are any. GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally ItemReturnDescription, ReturnAll (out) Indicates whether the item has any publicly displayed messages. Use GetMemberMessages to retrieve public messages for the item if this flag indicates that there are any. GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally ItemReturnDescription, ReturnAll (out) Indicates whether, for a Dutch Auction, there is a Buy It Now option. Germany site (site ID 77) and China site (site ID 223) only. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll (out) Type of seller account. This value can be returned if the German site (site ID 77) or eBay Motors site (site ID 100) is specified. GetSearchResults Conditionally (in/out) Specifies the minimum acceptable best offer price. If a buyer submits a best offer that is below this value, the offer is automatically declined by the seller. Applies only to items listed in categories that support the Best Offer Auto-Decline feature. Best Offer must be enabled for the item, and only the seller who listed the item can see this value. AddItem GetItemRecommendations ReviseItem RelistItem VerifyAddItem No GetItem none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll (in/out) Specifies the message sent from the seller to the buyer when a submitted best offer is automatically declined by the seller. A best offer is automatically declined if it does not meet the minimum acceptable best offer price specified by the seller with MinimumBestOfferPrice. Applies only to items listed in categories that support the Best Offer Auto-Decline feature. Best Offer must be enabled for the item. AddItem GetItemRecommendations ReviseItem RelistItem VerifyAddItem No GetItem Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll Specifies a distance in miles. This distance is used as the radius of the area about the supplied postal code that constitutes the local market. Local listings are limited to a distance of 100 miles. AddItem GetItemRecommendations Conditionally If true, the item appears on the eBay Express site associated with the item's listing site (US or Germany). Retrieving eBay Express Listings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressGetItem GetMyeBaySelling GetMyeBayBuying GetBidderList Always GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions Always ReturnAll GetOrderTransactions none Conditionally GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll (out) Indicates the item ID of the original item listing from which a Transaction Confirmation Request (TCR) was created. This value is only returned when the data for a TCR is retrieved. GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally none, ItemReturnDescription, ReturnAll GetBidderList Conditionally Applications should not depend on the completeness of ListingDurationCodeType. GetCategoryFeatures will return the complete list of listing durations. Each code in this code list specifies a number of days that a listing can be active (i.e., available for bidding/buying). The validity of a code depends on the listing type. Call GetCategoryFeatures to determine which listing formats support each duration for the site you are using. (in/out) 1 Day - A seller must have a positive feedback rating of 10 or more or must be ID Verified to use the 1-day listing duration on the US site. Typically applicable for Chinese and Dutch auction formats (including Real Estate) and Personal Offer (Second Chance Offer). Call GetCategoryFeatures to determine which listing formats support this duration for the site you are using. (in/out) 3 Days - Typically applicable to Chinese, Dutch, and Live auction formats (including Real Estate); Personal Offer (Second Chance Offer); and Basic Fixed-Price format. Call GetCategoryFeatures to determine which listing formats support this duration for the site you are using. (in/out) 5 Days - Typically applicable to Chinese, Dutch, and Live auction formats (including Real Estate); Personal Offer (Second Chance Offer); and Basic Fixed-Price format. Call GetCategoryFeatures to determine which listing formats support this duration for the site you are using. (in/out) 7 Days - Typically applicable to Chinese, Dutch, and Live auction formats (including Real Estate); Personal Offer (Second Chance Offer); and Basic Fixed-Price format. Call GetCategoryFeatures to determine which listing formats support this duration for the site you are using. (in/out) 10 Days - Subject to an additional listing upgrade fee. Typically applicable to Chinese, Dutch, and Live auction formats (including Real Estate) and Basic Fixed-Price format. Call GetCategoryFeatures to determine which listing formats support this duration for the site you are using. (in/out) 14 Days - Subject to an additional listing upgrade fee. Call GetCategoryFeatures to determine which listing formats support this duration for the site you are using. (in/out) 30 Days - Typically applicable to Real Estate Ad format and Store Inventory format. Call GetCategoryFeatures to determine which listing formats support this duration for the site you are using. (in/out) Call GetCategoryFeatures to determine which listing formats support this duration for the site you are using. (in/out) 90 Days - Typically applicable to Real Estate Ad format. Call GetCategoryFeatures to determine which listing formats support this duration for the site you are using. (in/out) Call GetCategoryFeatures to determine which listing formats support this duration for the site you are using. (in/out) GTC - Relist automatically every 30 days until all the items sell or the seller ends the listing. Typically applicable to Store Inventory format and Half.com listings. Call GetCategoryFeatures to determine which listing formats support this duration for the site you are using. (out) Reserved for internal or future use. A container node for a set of durations that apply to a certain listing type. Specifies the length of time an auction can be open, in days. The allowed durations vary according to the type of listing. The value GTC means Good Til Canceled. GetCategoryFeatures ReturnAll Conditionally Identifies the type of listing to which the set of durations applies. The durationSetID value corresponds to the listing types returned in Category.ListingDuration (also in the call response). GetCategoryFeatures ReturnAll Conditionally A container node for sets of durations, each set describing the durations allowed for one listing type. Contains the duration periods that apply to a certain listing type. GetCategoryFeatures ReturnAll Conditionally The current version of the feature. Some features (for example, ShippingTermsRequired) do not have version numbers. GetCategoryFeatures ReturnAll Conditionally Identifies the type of listing as an attribute on the ListingDuration node. The type of listing a set of durations describes. GetCategoryFeatures ReturnAll Conditionally ListingEnhancementsCodeType - Type declaration to be used by other schema. Indicates optional featuring properties of an item. Featuring properties make a listing stand out in a search or listing page, or let the item be featured on the eBay home page. (in/out) If specified, the seller wants the item to be displayed with a border that goes around the item in search result pages that return multiple items. The border differentiates the item from other items in the list. Applicable listing fees apply. AddItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No (in/out) If specified, the seller wants the title for the item's listing to be in boldface type. Applicable listing fees apply. Does not affect the item subtitle (Item.SubTitle), if any. Not applicable to eBay Motors. AddItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No (in/out) Listing is a "Featured Plus" item. The item will display prominently in the Featured Items section of its category list, and it will stand out on search results pages. It will also display in the regular, non-featured item list. Only available to users with a Feedback rating of 10 or greater. Not applicable to eBay Motors listings. AddItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No (in/out) Listing is highlighted in a different color in lists. AddItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No (in/out) Listing will have a chance to rotate into a special display on eBay's Home page. Your item is very likely to show up on the Home page, although eBay does not guarantee that your item will be highlighted in this way. This is the highest level of visibility on eBay. AddItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No (in/out) Listing is using ProPackBundle (a feature pack). Applies only to US and Canadian eBay motor vehicle sellers. Contains the BoldTitle, Border, Featured and Highlight features. (in/out) Listing is using BasicUpgradePackBundle (a feature pack). Australia site (site ID 15, abbreviation AU) only. Effective beginning February 22, 2006. Contains the Gallery and Subtitle features. AddItem RelistItem ReviseItem VerifyAddItem No (in/out) Listing is using ValuePack bundle (a feature pack), which combines the features Gallery, Subtitle, and Listing Designer for a discounted price. Support for this feature varies by site and category. Effective beginning February 22, 2006. AddItem RelistItem ReviseItem VerifyAddItem No (in/out) Listing is using ProPackPlus bundle (a feature pack), which combines the features BoldTitle, Border, Highlight, Featured, and Gallery for a discounted price. Support for this feature varies by site and category. Effective beginning February 22, 2006. AddItem RelistItem ReviseItem VerifyAddItem No (out) Reserved for internal or future use. eBay Listing Enhancements Codes Code List Agency - eBay, Inc. Code List Version - 1.0 ListingFlowCodeType - Type declaration to be used by other schema. Identifies the listing flows on the eBay Web site for use with calls like GetItemRecommendations. (in) AddItem (Sell Your Item) listing flow. (in) ReviseItem (Revise Your Item) listing flow. (in) RelistItem listing flow. (out) Reserved for internal or future use. Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing. (out) The listing is still active or the listing has ended with a sale but eBay has not completed processing the sale details (e.g., total price and high bidder). A multi-item listing is considered active until all items have winning bids or purchases or the listing ends with at least one winning bid or purchase. If the listing has ended with a sale but this Active status is returned, please allow several minutes for eBay to finish processing the listing. GetItem GetSellerList GetHighBidders GetAllBidders Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll (out) The listing has ended. If the listing ended with a sale, eBay has completed processing of the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. However, the final value fee is not yet available. GetItem GetSellerList GetHighBidders GetAllBidders Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll (out) The listing has closed and eBay has completed processing the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. Although the Final Value Fee for FixedPriceItem, StoresFixedPrice, and Buy It Now Dutch listing types is returned by GetSellerTransactions and GetItemTransactions on a transaction by transaction basis, all other listing types, including Chinese and Dutch (no Buy It Now purchases), require the listing status to be Completed before the Final Value Fee is returned. GetItem GetSellerList GetHighBidders GetAllBidders Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll (out) Reserved for internal or future use. (out) Reserved for internal or future use. Indicates the specific type of lead generation format listing (i.e., classified subtypes). Reserved for future use. (out) Contains a list of tips on improving a listing's details, if any. An individual tip on improving a listing's details. GetItemRecommendations Conditionally (out) Identifies the item field that the tip relates to. Identifier associated with the item field. Primarily for internal use. This value may change over time. GetItemRecommendations Conditionally Related text that appears near a field or at the top of the section within which the field appears in the selling flow. 125 GetItemRecommendations Conditionally A label used to preface the current value of a field. For example, "Current value" would be the CurrentValueText in "Current value: 25". If no label exists, this element is not returned. 50 GetItemRecommendations Conditionally Current value of the field (in the listing or in the candidate item) or meta-data about the value. For example, if the tip is recommending a longer item title, the CurrentFieldValue might specify the current length of the title. If no current value is available, this information is not returned. GetItemRecommendations Conditionally (out) Contains the message portion of a listing tip that is returned by the Listing Analyzer engine. Identifier for the tip message. Primarily for internal use. This value may change over time. GetItemRecommendations Conditionally Brief version of the tip message. 125 GetItemRecommendations Conditionally Detailed version of the tip message. 125 GetItemRecommendations Conditionally Path part of a URL for a "Learn More" link that points to a relevant eBay Web site online help page. The path is relative to http://pages.ebay.XX, where XX is the 2-letter site code (e.g., http://pages.ebay.de for the eBay Germany site). Applications should append the URL to the appropriate path for the user's site. 125 GetItemRecommendations Conditionally (out) A tip on improving a listing's details. Tips are returned from the Listing Analyzer engine. Identifier for the tip. Primarily for internal use. This value may change over time. GetItemRecommendations Conditionally The rank of the tip. All tips are ranked by importance. Ranking varies for each site. The rank is always greater than 0. GetItemRecommendations Conditionally The tip's message content. GetItemRecommendations Conditionally The item field that is associated with the tip. GetItemRecommendations Conditionally Specifies the selling format used for a listing. (out) Unknown auction type. AddItem VerifyAddItem No GetItem Conditionally GetCategoryFeatures ReturnAll Conditionally (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. AddItem VerifyAddItem No GetItem Conditionally GetCategoryFeatures ReturnAll Conditionally (in/out) Multiple-quantity online auction format. A Dutch auction has a Quantity greater than 1. Buyers engage in competitive bidding. Some sites also offer Buy It Now for Dutch auctions. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. AddItem VerifyAddItem No GetItem Conditionally GetCategoryFeatures ReturnAll Conditionally (out) Live auction, on-site auction that can include non-eBay bidders. Use AddLiveAuctionItem to list live auctions. Live auctions are listed on the eBay Live Auctions site, in live auction categories. They can also appear on eBay if the seller lists the lot in a secondary category that is an eBay category. GetItem Conditionally GetCategoryFeatures ReturnAll Conditionally (in) An optional input parameter used with GetMyeBaySelling. When used in the request, returns items of the following auction types: Chinese, Dutch, and Live. GetMyeBaySelling No ActiveList (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. AddItem VerifyAddItem No GetMyeBaySelling No ActiveList GetItem Conditionally GetCategoryFeatures ReturnAll Conditionally (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. AddItem VerifyAddItem No GetMyeBaySelling No ActiveList GetItem Conditionally GetCategoryFeatures ReturnAll Conditionally (out) Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. GetItem Conditionally GetCategoryFeatures ReturnAll Conditionally (in/out) A basic fixed-price format. A fixed-price listing with a Quantity of 1 or more. Allows no auction-style bidding. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers need to meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the eBay Web Services guide. Fixed-price listings are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. AddItem VerifyAddItem No GetMyeBaySelling No ActiveList GetItem Conditionally GetCategoryFeatures ReturnAll Conditionally (in/out) Half.com listing (item is listed on Half.com, not on eBay). You must be a registered Half.com seller to use this format. See Working with Half.com Listings in the eBay Web Services guide. AddItem ReviseItem VerifyAddItem Conditionally (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). AddItem Conditionally GetItem Conditionally GetCategoryFeatures ReturnAll Conditionally (in/out) Coming soon for Germany only: eBay Express format (item is listed only on eBay Express only, not on eBay). You must be a vetted Express Germany seller to use this format. See "List Items in a Fixed Price Format" in the eBay Web Services guide. AddItem VerifyAddItem No GetItem Conditionally (out) Reserved for internal or future use. Contains the results of the request for each bidder. Indicates the current approval status of a bidder. ApproveLiveAuctionBidders Always The approval status of a user who wants to bid on a live auction. User ID of the bidder. ApproveLiveAuctionBidders Always The bidder's approval status. Possible values are Approvied, Denied, or a message indicating a problem that prevented the bidder from being approved (or denied), such as an invalid ApproveBiddingLimit value. ApproveLiveAuctionBidders Always Container for a list of Live Auction Bidders, such as returned by GetLiveAuctionBidders. Will contain zero, one, or multiple LiveAuctionBidType bidders, each of which represents one bidder's request listing that was found by the search. Output only. Contains data for an item listing found by a search. Output only. GetLiveAuctionBidders Conditionally Contains the data for one listing found by a search . Amount that user has requested for the approval. This is returned if the auction house has requested that the bidder enter an amount for the approval. GetLiveAuctionBidders Always Indicates whether the user is "approved","denied", or "pending" or a combination of these. GetLiveAuctionBidders Always Amount that has been approved by the seller. If the seller has not yet approved, return value "Pending" GetLiveAuctionBidders Always Comments entered by the seller when it declined an approval request, if any. GetLiveAuctionBidders Always (out) Describes one live auction catalog and its sale schedules. Use this information to determine an appropriate combination of catalog and schedule IDs in which to list a lot item when you use AddLiveAuctionItem. (out) ID number identifiying a specific eBay Live Auctions catalog that the user has created. Pass as input to AddLiveAuctionItem when you list a lot item. GetLiveAuctionCatalogDetails Conditionally (out) Descriptive name that the seller created for the catalog. Pass as input to AddLiveAuctionItem when you list a lot item. 45 GetLiveAuctionCatalogDetails Conditionally (out) Describes a single live auction sale schedule that the user defined. A seller can define a maximum of 5 schedules for each catalog. Each schedule defines the start and end time of a live auction event. (Only the start time is returned from GetLiveAuctionCatalogDetails.) A schedule must be created at least 48 hours in advance of the auction. The seller then lists one or more lots that will be auctioned during that event. Only schedules for future sales are returned. That is, schedules for ended sales or sales in progress are not returned. Pass as input to AddLiveAuctionItem when you list a lot item. GetLiveAuctionCatalogDetails Conditionally (in) Describes the live auction-specific details of a lot item. (in) Number that identifies the seller's eBay Live Auctions catalog within which the lot item will be listed. Use GetLiveAuctionCatalogDetails to determine the seller's available catalog IDs. AddLiveAuctionItem Yes (in) Number that identifies the sale schedule for the lot. The schedule ID must be for a pending sale associated with the catalog identified in UserCatalogID. Call GetLiveAuctionCatalogDetails to determine the valid schedule IDs for the catalog. AddLiveAuctionItem ReviseLiveAuctionItem Yes (in) Lot number defined by the seller. Each lot number must be unique within the schedule. A lot number can consist of 1-10 alphanumeric characters beginning with a number from 0-9. If all values are numbers, the highest allowed value is 2147483647. AddLiveAuctionItem Yes ReviseLiveAuctionItem No (in) Highest appraised value for the item. Must be greater than zero and greater than the value in LowEstimate. (Pass an integer value only, not a double.) AddLiveAuctionItem Yes ReviseLiveAuctionItem No (in) Lowest appraised value for the item. Must be greater than zero and less than the value in HighEstimate. (Pass an integer value only, not a double.) AddLiveAuctionItem Yes ReviseLiveAuctionItem No Defines the LocalMarketNonSubscription feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Defines the LocalMarketPremiumSubscription feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Defines the LocalMarketRegularSubscription feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Defines the LocalMarketSpecialitySubscription feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Contains data for filtering a search by proximity. The maximum distance from the specified postal code to search for items. GetSearchResults GetCategoryListings No The postal code to use as the basis for the proximity search. GetSearchResults GetCategoryListings No Only valid when using AddItem for items in Media categories (Books, DVD and Movies, Music, and Video Game categories). You can pass either AttributeSetArrayType or LookupAttributeArrayType, but you cannot pass both containers in the same request. See the eBay Web Services guide for additional information. The condition of the item. AddItem GetItemRecommendations RelistItem VerifyAddItem No (in) An optional attribute that the seller wants to include in the listing. Enables you to specify an attribute by name rather than by ID. Only valid in Media categories (Books, DVD and Movies, Music, and Video Game categories). Currently, only the Condition attribute is supported. (in) The literal name of the attribute. Pass "Condition" (without quotes). Not applicable to Half.com. AddItem GetItemRecommendations RelistItem VerifyAddItem No (in) The literal name of the attribute value. Pass "New" or "Used" (without quotes). Not applicable to Half.com. AddItem GetItemRecommendations RelistItem VerifyAddItem No Describes an individual mark-up or mark-down event. eBay will automatically mark an application as down if attempts to deliver a notification fail repeatedly. eBay may mark an application down manually under certain circumstances. (out) Whether the application has been marked up or marked down. GetNotificationsUsage Conditionally (out) Time when the application was marked up or marked down. GetNotificationsUsage Conditionally (out) Describes how the application was marked down, automatically or manually. When an application is automatically marked down, eBay will ping the application periodically, and if communication is restored, eBay will automatically mark the application up. If your application is marked down manually, you must contact eBay Developer Support to get your application marked up. A Reason is not provided for mark up events. GetNotificationsUsage Conditionally Valid application status codes, either MarkUp (application was marked up, communication is restored) or MarkDown (application was marked down, no communication). (out) Status indicating the application was or is marked up. GetNotificationsUsage Conditionally (out) Status indicating the application was marked down. GetNotificationsUsage Conditionally (out) Reserved for future internal or external use. List of objects representing markup or markdown events for a given application and time period. If no time period is specified in the request, the information for only one day (24 hours before the time the call is made to the time the call is made) is included. The maximum time period is allowed is 3 days (72 hours before the call is made to the time the call is made). (out) Details for a MarkDown or MarkUp event. GetNotificationsUsage Conditionally Container for items bid. (in/out) If this field is present, blocking is enabled, where the value of this field represents the maximum number of this seller's items a bidder is allowed to bid on in a 10 day period before being blocked. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 25, 50, 75, 100. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem GetSellerList Conditionally (in/out) This field is ignored on input unless MaximumItemCount has been provided. If this field is present, the user's feedback score is also considered: a user is blocked from bidding if the user's feedback score is less than or equal to the value of this field. Valid values: 0, 1, 2, 3, 4, 5. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem GetSellerList Conditionally Container for messages. Returned for GetMemberMessages if messages that meet the request criteria exist. Information about individual messages. Returned if the parent container is returned. GetMemberMessages Conditionally Container for message metadata. The item about which the question was asked. Returned if the parent container is returned. GetMemberMessages Conditionally Contains all the information about the question being asked. Returned if the parent container is returned. GetMemberMessages Conditionally An answer to the question. Returned if the parent container is returned. GetMemberMessages Conditionally The status of the message. Returned if the parent container is returned. GetMemberMessages Conditionally Date the message was created. Used to filter response. Returned if the parent container is returned. Date the message was last modified. Returned if the parent container is returned. GetMemberMessages Conditionally (in/out) Container for individual message information. (in/out) The type of message being retrieved. For AddMemberMessage, any value besides ResponseToASQQuestion returns an error. AddMemberMessage AddMemberMessagesAAQToBidder Yes GetMemberMessages Conditionally (in/out) The context of the question (e.g. Shipping, General). Ignored input for AddMemberMessage.MessageType = ResponseToASQQuestion. AddMemberMessage No AddMemberMessageAAQToPartner Yes GetMemberMessages Conditionally (in) Specifies whether or not to email a copy of the message to the sender. If omitted, this defaults to whatever the user set in preferences. omitted AddMemberMessage AddMemberMessageAAQToPartner AddMemberMessageRTQ AddMemberMessagesAAQToBidder No Specifies whether or not to hide sender's email address from the recipient. If omitted, this defaults to whatever the user set in preferences--or on site policy, which determines whether or not this field is recognized. omitted AddMemberMessage AddMemberMessageAAQToPartner AddMemberMessageRTQ AddMemberMessagesAAQToBidder No (in/out) Specifies if the body should be displayed to the public. Ignored input for AddMemberMessage.MessageType = ResponseToASQQuestion. AddMemberMessage No GetMemberMessages Conditionally (out) The eBay user ID of the person who asked the question or sent the message. GetMemberMessages Conditionally The email address of the person who asked the question or sent the message. Returned by the AskSellerQuestion notification. (in/out) Recipient's eBay user ID. For AddMemberMessagesAAQToBidder, must be the seller of an item, that item's bidder, or a user who has made an offer on that item via Best Offer. AddMemberMessage AddMemberMessageAAQToPartner AddMemberMessageRTQ AddMemberMessagesAAQToBidder Yes GetMemberMessages Conditionally (out) Subject of this email message. Ignored input for AddMemberMessage.MessageType = ResponseToASQQuestion. AddMemberMessage No GetMemberMessages Conditionally (in/out) Message content. Required input for AddMemberMessage.MessageType = ResponseToASQQuestion. 1000 AddMemberMessageAAQToPartner AddMemberMessageRTQ AddMemberMessagesAAQToBidder Yes AddMemberMessage Conditionally GetMemberMessages Conditionally (out) An ID that uniquely identifies a message for a given user. AddMemberMessage No GetMemberMessages Conditionally (in) ID number of the question this message is responding to. AddMemberMessage Yes AddMemberMessageRTQ Yes Specifies whether an eBay Stores seller prefers to promote items with a cross-promotion widget that is customized with the store theme or uses the default eBay theme. This option is the same as the one set on the seller's Customize Cross-Promotion Display page. (in/out) Uses the default eBay theme for cross-promotion widgets. (in/out) Uses the store theme for cross-promotion widgets. (out) Reserved for internal or future use. MerchandizingPrefCodeType - Type declaration to be used by other schema. Indicates whether the seller has opted to participate in item cross-promotion through the Merchandising Manager feature. This option is set on the user's My eBay page and determines whether the seller's other items are cross-promoted with items from the seller that are listed or sold. (in/out) Seller allows item cross-promotion. (in/out) Seller does not allow item cross-promotion. (out) Reserved for internal or future use. The question has been answered at least once. The question has not yet been answered. Not available. Member to Member message initiated by bidder/potential bidder to a seller of a particular item. Member to Member message initiated as a response to an Ask A Question message. Member to Member message initiated by any eBay member to another eBay member. Member message between transaction partners within 90 days after the transaction. Reserved for future or internal use. Defines the Minimum Reserve Price feature. If the field is present, the feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Identifies the fields that are being modified. Only applies when revising and relisting items. To remove a property from an object, specify it in ModifiedFieldType, but do not specify a value in the object type (for example, ItemType). The name of the field that is being modified. Use only first-level properties. The first letter of each node in the field is case insensitive, so item.startPrice is the same as Item.StartPrice. In RelistItem, this is required if you are also modifying fields of the item that you are relisting. RelistItem GetItemRecommendations Conditionally Deprecated ReviseItem Yes Deprecated ReviseLiveAuctionItem Yes Instruction describing the nature of the modification. In RelistItem, this is required if you are modifying fields of the item that you are relisting. See the ModifyCodeList for valid values. RelistItem Conditionally Deprecated ReviseItem Yes Deprecated ReviseLiveAuctionItem Yes Specifies what action to take with the entry that is being modified. (in) Add the entry (in) Delete the entry (in) Update the entry (out) Reserved for internal or future use ModifyCodeType - Type declaration to be used by other schema. This code identifies the types of modifications that can be made to an object. For example, use this when changing or removing field values when re-listing an item. (in) Indicates that the value of the specified field should be removed. Do not use to remove a property from a listing with ReviseItem or RelistItem. See the Developer's Guide for details. Also applicable to Half.com. ReviseItem Conditionally (in) Indicates that the value of the specified field should be modified. Also applicable to Half.com. ReviseItem Conditionally Reserved for internal or future use. Contains a list of alert data. (out) Contains the data for one alert. Returned for detail levels ReturnHeaders and ReturnMessages. Parent returned as an empty node if user has no alerts. GetMyMessages Conditionally ReturnHeaders, ReturnMessages Contains a list of up to 10 AlertID values. (in/out) An ID that uniquely identifies an alert for a given user. When AlertID values are used as input, you must generally specify either AlertID values, or MessageID values, or both. DeleteMyMessages GetMyMessages ReviseMyMessages Conditionally MyMessagesAlertResolutionStatusCode - Whether or not an alert was resolved, and how. The alert has not been resolved. If the alert requires user action, an unresolved status means that the user did not take action on the alert. If the alert does not require user action, an unresolved status means that the alert has not been read. Note that an unresolved alert can not be deleted. The alert was resolved by auto resolution. The alert was resolved by user. If the alert requires user action, resolved status means that the user took the necessary action on the alert. If the alert does not require user action, resolved status means that the alert was read by the user. (out) Returns an alert header and full alert information. (out) The display name of the eBay application that sends the alert. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) The displayable user ID of the recipient. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) The subject of the alert. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) A number ranging from 0 to 10000 (inclusive), with 10000 having the highest priority. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) An ID that uniquely identifies an alert for a given user. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) An ID used by an external application to uniquely identify an alert. GetMyMessages Conditionally ReturnHeaders (out) The content type of the body text. The two acceptable values are "TEXT" and "HTML" (case sensitive). (out) The alert body. This can be either plain text or HTML, depending on which format the alert was originally written in. Note that the API does not currently check the user email format preferences that can be specified in My Messages on the eBay.com Web site. GetMyMessages Conditionally ReturnMessages (out) Whether or not an alert was resolved, and how. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) Whether or not an alert was viewed by a given user. Note that retrieving an alert with the API does not mark it as read. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) The date and time an alert was created by a sender. (out) The date and time that an alert was received by My Messages and stored in a database for the recipient. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) The date and time at which an alert expires. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) The date and time at which an alert is resolved. (out) The date and time an alert was last viewed by a given user. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) A unique eBay item ID associated with an alert. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetMyMessages Conditionally ReturnHeaders (out) Indicates whether or not a time-delayed resolution is applicable for an alert. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) A URL that the recipient must visit to resolve an alert. May be returned as an empty tag if there is no applicable URL. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) Details relating to the response to an alert or message. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) Details relating to the forwarding of an alert or message. (out) Details relating to a My Messages folder. GetMyMessages Conditionally ReturnHeaders, ReturnMessages MyMessagesFolderOperationCodeType - Indicates the type of operation to perform on a specified My Messsages folder. Operations cannot be performed on the Inbox or Sent folders. If a folder has been removed, restores the specified folder in My Messages. Because the Inbox and Sent folders cannot be removed, they can also not be restored. Requires FolderName as input. Renames a specified folder. Inbox and Sent folders cannot be renamed. To rename a folder, use FolderID to indicate the folder to rename, and FolderName to indicate the new name. Removes a specified folder. Inbox and Sent folders cannot be removed. Removing a folder that is not empty returns an error. Requires FolderID as input. Reserved for future or internal use. Summary details for a specified My Messages folder. (out) An ID that uniquely identifies a My Messages folder. Always returned for detail level ReturnSummary. GetMyMessages Conditionally ReturnSummary (out) The name of a specified My Messages folder. For GetMyMessages, Inbox (FolderID = 0) and Sent (FolderID = 1) are not returned. GetMyMessages Conditionally ReturnSummary (out) The number of new alerts in a given folder. Always returned for detail level ReturnSummary. GetMyMessages Conditionally ReturnSummary (out) The number of new messages in a given folder. Always returned for detail level ReturnSummary. GetMyMessages Conditionally ReturnSummary (out) The total number of alerts in a given folder. Always returned for detail level ReturnSummary. GetMyMessages Conditionally ReturnSummary (out) The total number of messages in a given folder. Always returned for detail level ReturnSummary. GetMyMessages Conditionally ReturnSummary Details relating to a My Messages folder. An ID that uniquely identifies a My Messages folder. GetMyMessages Conditionally Alerts Messages ReturnHeaders, ReturnMessages The name of a specified My Messages folder. Details relating to the forwarding of an alert or message. The date and time a user forwarded an alert or message. GetMyMessages Conditionally Encoding used to forward an alert or message. GetMyMessages Conditionally Contains a list of message data. (out) Contains the data for one message. GetMyMessages Conditionally ReturnHeaders, ReturnMessages Contains a list of up to 10 MessageID values. (in/out) An ID that uniquely identifies a message for a given user. When MessageID values are used as input, you must generally specify either AlertID values, or MessageID values, or both. DeleteMyMessages Conditionally GetMyMessages Conditionally ReviseMyMessages Conditionally (out) Contains the message information for each message specified in MessageIDs. The amount and type of information returned varies based on the requested detail level. (out) The display name of the eBay user that sent the message. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) The displayable user ID of the recipient. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) The displayable name of the user or eBay application to which the message is sent. Only returned for M2M, and if a value exists. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) The subject of the message. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) An ID that uniquely identifies a message for a given user. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) An ID used by an external application to uniquely identify a message. (out) The content type of the body text. The three acceptable values are "TEXT", "HTML", and "XML" (case sensitive). (out) The message body. This can be either plain text or HTML, depending on which format the message was originally written in. Note that the API does not currently check the user email format preferences that can be specified in My Messages on the eBay.com Web site. GetMyMessages Conditionally ReturnMessages (out) Whether or not a message has been flagged. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) Whether or not a message has been viewed by a given user. Note that retrieving a message with the API does not mark it as read. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) The date and time that a message was created by the sender. (out) The date and time that a message was received by My Messages and stored in a database for the recipient. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) The date and time at which a message expires. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) A unique eBay Item ID associated with a message. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) (out) Details relating to the response to an alert or message. GetMyMessages Conditionally ReturnHeaders, ReturnMessages (out) Details relating to the forwarding of an alert or message. (out) Details relating to a My Messages folder. Details relating to the response to an alert or message. Whether or not an alert or message can be responded to. To respond to an alert or message, use the URL in ResponseURL. You may need to log into the eBay Web site to complete the response. GetMyMessages Conditionally Alerts Messages ReturnHeaders, ReturnMessages A URL that the recipient must visit to respond to an alert or message. Responding may require logging into the eBay Web site. GetMyMessages Conditionally Alerts ReturnMessages GetMyMessages Conditionally Messages ReturnHeaders, ReturnMessages The date and time the user responded to an alert or message Summary data for a given user's alerts and messages. This includes the numbers of new alerts and messages, unresolved alerts, flagged messages, and total alerts and messages. (out) Folder summary for each folder. Always returned for detail level ReturnSummary. GetMyMessages Conditionally ReturnSummary (out) The number of new alerts that a given user has. Always returned for detail level ReturnSummary. GetMyMessages Conditionally ReturnSummary (out) The number of new messages that a given user has. Always returned for detail level ReturnSummary. GetMyMessages Conditionally ReturnSummary (out) The number of alerts that are not yet resolved. Always returned for detail level ReturnSummary. GetMyMessages Conditionally ReturnSummary (out) The number of messages that have been flagged. Always returned for detail level ReturnSummary. GetMyMessages Conditionally ReturnSummary (out) The total number of alerts for a given user. Always returned for detail level ReturnSummary. GetMyMessages Conditionally ReturnSummary (out) The total number of messages for a given user. Always returned for detail level ReturnSummary. GetMyMessages Conditionally ReturnSummary A list of favorite searches a user has saved on the My eBay page. The total number of favorite searches saved. GetMyeBayBuying Conditionally A favorite search the user has saved, with a name and a search query. GetMyeBayBuying Conditionally Characteristics of a saved My eBay Favorite Search. The name of the My eBay Favorite Search. GetMyeBayBuying Conditionally The query string of a My eBay Favorite Search. GetMyeBayBuying Conditionally A list of favorite sellers the user has saved on the My eBay page. The total number of favorite sellers saved. 100 GetMyeBayBuying Conditionally A favorite seller the user has saved, with a user ID and store name. GetMyeBayBuying Conditionally Characteristics of the My eBay Favorite Seller. The favorite seller's eBay user ID. GetMyeBayBuying Conditionally The name of the store owned by the favorite seller, if applicable. GetMyeBayBuying Conditionally A list of possible My eBay Second Chance Offers. The total number of My eBay Second Chance Offers available. A Second Chance Offer item. Specifies how the result list for My eBay features such as favorite searches, favorite sellers, and second chance offers should be returned. Specifies whether to include a container in the response. Required if you do not specify any other tags to filter the result list. If so, the list is returned according to the default values. Ignored if you specify at least one other tag for the result list. GetMyeBayBuying No Specifies the result sort order. Default is Ascending. GetMyeBayBuying No Specifies the maximum number of items in the returned list. If not specified, returns all items in the list. GetMyeBayBuying No A list of one or more valid names and corresponding values. A name and corresponding value (a name/value pair). In the GetSearchResults response, this is only returned for applicable items when the value of IncludeCondition was true in the GetSearchResults request, or when SearchRequest was used to perform a "Product Finder" search. In the GetSearchResultsExpress response, this is only returned when ProductDetails is set to Fine. GetSearchResults Conditionally GetSearchResultsExpress Conditionally A name and corresponding value (a name/value pair). A name in a name/value pair. In the GetSearchResults response, this is an attribute name. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetSearchResultsExpress response, this is an attribute name. Only returned when ProductDetails is set to Fine. GetSearchResults Conditionally GetSearchResultsExpress Conditionally The value in a name/value pair. In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute (i.e., the value of one Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). In the GetSearchResultsExpress response, this is an attribute value. Only returned when ProductDetails is set to Fine. GetSearchResults Conditionally GetSearchResultsExpress Conditionally Valid notification status codes Reserved for future internal or external use Status indicating the notification was delivered Status indicating the notification was failed Status indicating the notification was rejected Status indicating the notification was marked down Returns information about notifications sent to the given application for the given ItemID. It will only be returned if ItemID was specified in the input parameters. (out) List of notifications, if there are any, for the given ItemID and given time period. GetNotificationsUsage Conditionally Information about a single notification. Notification information includes the reference ID, notification type, current status, time delivered, error code, and error message for the notification. If notification details are included in the response, all of the detail fields are returned. (out) Returns the destination address for the notification. This is the value set using SetNotificationPreferences. GetNotificationsUsage Conditionally (out) Reference identifier for the notification. (out) Date and time when this notification will be removed from the eBay system. GetNotificationsUsage Conditionally (out) Returns the notification type. Possible values include: AskSellerQuestion, AuctionCheckoutComplete, BestOffer, CheckoutBuyerRequestTotal, EndOfAuction, Feedback, FixedPriceEndOfTransaction, FixedPriceTransaction, ItemNotReceived, MyMessages, OutBid, SecondChanceOffer, UPIBuyerResponseDispute, UPISellerClosedDispute, UPISellerOpenedDispute, and UPISellerRespondedToDispute. GetNotificationsUsage Conditionally (out) Returns the total number of retries for the given notification. GetNotificationsUsage Conditionally (out) Returns the notification status. Possible values include Delivered, Failed, Rejected, and MarkedDown. GetNotificationsUsage Conditionally (out) Returns the time when the notification is scheduled for retry. This won't be included if the DeliveryStatus is Delivered. GetNotificationsUsage Conditionally (out) Returns the time when the notification was delivered. GetNotificationsUsage Conditionally (out) Returns the error message. GetNotificationsUsage Conditionally (in/out) A list of NotificationEnable entries. Each entry specifies one notification and whether it is enabled. (in/out) Specifies one notification event and whether it is enabled or disabled. Returned if previously set. SetNotificationPreferences No GetNotificationPreferences Conditionally (in/out) Specifies a notification event and whether the notification is enabled or disabled. (in/out) The name of the notification event. GetNotificationPreferences Conditionally SetNotificationPreferences No (in/out) Whether the event is enabled or disabled. GetNotificationPreferences Conditionally SetNotificationPreferences No Defines all property names that can be used. (in/out) Property name for WatchItemEndingSoon event, part of enabling a user to specify a time in minutes before the end of the listing. Reserved for future use. (in/out) Defines properties associated with particular event. (in/out) The name of the notification event. GetNotificationPreferences Conditionally SetNotificationPreferences No (in/out) Specify property name associated with an particular event. GetNotificationPreferences Conditionally SetNotificationPreferences No (in/out) Specifies the value for the property. GetNotificationPreferences Conditionally SetNotificationPreferences No Valid notification status codes Status indicating the notification is newly created Status indicating the notification was failed Status indicating the end user application is marked down Status indicating the notification is pending Status indicating the notification is failed pending Status indicating the notification is marked down pending Status indicating the notification was successfully delivered Status indicating the notification was unable to deliver Status indicating the notification was rejected Status indicating the notification was cancelled Reserved for future internal or external use Defines all notification events that can be used. (out) Not a notification event. (in/out) Sent to a user when another buyer has placed a higher maximum bid and the user is no longer the current high bidder. (in/out) Sent when an auction ends. An auction ends either when its duration expires, the buyer purchases an item with Buy It Now, or the auction is canceled. Applies to both Chinese and Dutch auctions. (in/out) Sent to a seller when a buyer completes the checkout process for an item. Occurs even when a seller has disabled checkout and the buyer uses eBayPayments. (in/out) Sent to a seller when a fixed-price item is sold and the buyer completes the checkout process. Not sent when a fixed-price item's duration expires without purchase. (in/out) Sent to a seller each time a buyer requests a total price. Occurs before checkout is complete. (in/out) Sent to a partner when a buyer leaves a feedback entry for a seller or when the seller responds. (in/out) Sent to a partner when a buyer leaves a feedback entry for a seller or when the seller responds. This tag is to be phased out. It is used here only for backward compatibility. (in/out) Sent to a user when a listing for a fixed price item ends. A fixed price listing ends when a buyer starts to move through checkout or purchases the item. Reserved for future use. (in/out) Sent to a seller when a question is posted about one of the seller's active listings. (in/out) Sent to an eBay partner on behalf of a seller when a seller has listed an item. Sent for each item the seller lists. (in/out) Specifies an ItemRevised notification event. (in/out) Sent to an eBay partner on behalf of a seller when a buyer responds to a dispute the seller has opened. Sent for each response the buyer makes. (in/out) Sent to an eBay partner on behalf of a seller when a seller opens a dispute. Sent for each dispute the seller opens. (in/out) Sent to an eBay partner on behalf of a seller when a seller responds to a dispute they had opened. Sent for each response the seller makes. (in/out) Sent to an eBay partner on behalf of a seller when a seller closes a dispute they had opened. Sent for each closure the seller performs. (in/out) Sent to a seller when a bidder makes a best offer on an item opted into the Best Offer feature by the seller. (in/out) A notification type where a specified user or application is notified when an alert is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnHeaders. MyMessagesAlertHeader and MyMessagesAlert cannot be subscribed to at the same time or specified in the same call. (in/out) A notification type where a specified user or application is notified when an alert is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnMessages. MyMessagesAlertHeader and MyMessagesAlert cannot be subscribed to at the same time or specified in the same call. (in/out) A notification type where a specified user or application is notified when a message from eBay is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnHeaders. MyMessageseBayMessageHeader and MyMessageseBayMessage cannot be subscribed to at the same time or specified in the same call. (in/out) A notification type where a specified user or application is notified when a message from eBay is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnMessages. MyMessageseBayMessageHeader and MyMessageseBayMessage cannot be subscribed to at the same time or specified in the same call. (in/out) A notification type where a specified user or application is notified when a member to member (M2M) message is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnHeaders. MyMessagesM2MMessageHeader and MyMessagesM2MMessage cannot be subscribed to at the same time or specified in the same call. (in/out) A notification type where a specified user or application is notified when a member to member (M2M) message is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnMessages. MyMessagesM2MMessageHeader and MyMessagesM2MMessage cannot be subscribed to at the same time or specified in the same call. (in/out) A notification type where a specified user or application is notified on behalf of a buyer when a buyer opens an Item Not Received dispute. Sent for each dispute the buyer opens. (in/out) A notification type where a specified user or application is notified on behalf of a buyer when a buyer responds to Item Not Received dispute that buyer had opened. Sent for each response the buyer makes. (in/out) A notification type where a specified user or application is notified on behalf of a buyer when a buyer closes Item Not Received dispute that buyer had opened. Sent for each closure the buyer performs. (in/out) A notification type where a specified user or application is notified on behalf of a seller when a seller responds to an Item Not Received dispute that buyer had opened. Sent for each response the seller makes. (in/out) A notification type where an application is notified that checkout has been handled by eBay Express. (in/out) A notification type where the listing of the watched item is about to end. This event has a property with which caller can specify the TimeLeft before the listing ends. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. (in/out) An informational alert about account activity. It is not triggered by an event but rather by an eBay daemon process that monitors a schedule database. (out) Reserved for internal or future use (out) A template for an SMS notification message. (out) The SMS message. Conditionally (out) The EIAS userId. Conditionally The schema options for Platform Notifications. (in/out) New Schema format (used by the new schema XML API and SOAP API). (out) Reserved for internal or future use Defines roles for platform notifications. (in/out) Specifies that you want to set or return application-level preferences. Default value. (in/out) Specifies that you want to set or return user-level preferences. (in/out) Specifies that you want to set or return user data-level preferences. (in/out) Specifies that you want to set or return event-level preferences. (out) Reserved for internal or future use Summary information about notifications delivered, failed, errors, queued for a given application ID and time period. Returns the number of notifications delivered successfully during the given time period. GetNotificationsUsage Always Returns the number of new notifications that were queued during the given time period. GetNotificationsUsage Always Returns the number of pending notifications in the queue during the given time period. GetNotificationsUsage Always Returns the number of notifications that permanently failed during the given time period. GetNotificationsUsage Always Returns the number of notifications for which there were delivery errors during the given time period. GetNotificationsUsage Always User data related to notifications. User data related to SMS notifications. SetNotificationPreferences Conditionally GetNotificationPreferences Conditionally User account activity summary alert delivery schedule. Returned if PreferenceLevel is set to UserData in GetNotificationPreferences. See "Working with Platform Notifications" for instructions on "Informational Alerts". SetNotificationPreferences Conditionally GetNotificationPreferences Conditionally Container for a list of offers. May contain zero, one, or multiple OfferType objects, each of which represents one offer extended by a user on a listing. Contains the data for one offer. This includes: data for the user making the offer, the amount of the offer, the quantity of items being bought from the listing, the type of offer being made, and more. GetAllBidders GetHighBidders Conditionally Contains information pertaining to an offer made on an item listing and the current bidding or purchase state of the listing. Indicates the type of offer being made on the specified listing. Valid values are enumerated in the BidActionCodeType code list. GetAllBidders GetHighBidders Always PlaceOffer Yes Numeric ID for the currency for the auction. Valid values are enumerated in the CurrencyCodeType code list. GetAllBidders GetHighBidders Always The unique identifier of an item listed on the eBay site. Returned by eBay when the item is created. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) Amount of the offer placed. For competitive-bidding listings, the amount bid on the item (subject to outbid by other buyers). For fixed-price listings, the fixed sale price at which the item is purchased. For competitive-bidding listings with an active Buy It Now option, this amount will be either the Buy It Now price for purchase or the amount of a bid, depending on the offer type (as specified in Action). For PlaceOffer, the currencyID attribute is ignored if provided. GetAllBidders GetHighBidders Always PlaceOffer Yes Specifies the number of items from the specified listing the user tendering the offer intends to purchase or bid on. For Chinese auctions and other listing formats that only allow one item per listing, value may not exceed one. For multi-item listings, must be greater than zero and not exceeding the number of items offered for sale in the listing. GetAllBidders GetHighBidders Always PlaceOffer Yes Indicates the user's preference to accept second chance offers. If true, the user is willing to be the recipient of second chance offers. GetAllBidders Always Unique ID identifying the currency in which the localized offer amounts are expressed. GetAllBidders GetHighBidders Always Date and time the offer or bid was placed. GetAllBidders GetHighBidders Always Amount the highest bidder had bid on the item. Applicable only to competitive-bidding listings (Chinese and Dutch auctions) where there is progressive bidding and winning bidders are determined based on the highest bid. GetAllBidders Always Localized amount for the item's current price. GetAllBidders GetHighBidders Conditionally The unique identifier of the transaction. The transaction is created when a winning bidder commits to purchasing an item, even before the bidder has paid. 10 Bidder information. See the schema documentation for UserType for details on its properties and their meanings. GetAllBidders GetHighBidders Always If true, confirms that the bidder read and agrees to eBay's privacy policy. Applies if the subject item is in a category that requires user consent. If user consent (that is, confirmation that a bidder read and agrees to eBay's privacy policy) is required for a category that the subject item is in, this value must be true for a bid to occur. PlaceOffer No Specifies whether the rules being defined are item rules or default rules. A new item rule is created if no rule exists with the same scheme; otherwise, it replaces one existing item rule. A new default rule replaces the entire set of rules for that promotion method. Use when setting item-specific rules. Use when setting default rules. (out) Reserved for internal or future use An array of Orders. Also applicable to Half.com. GetOrders Always GetOrderTransactions none Always A list of unique identifiers for orders. A unique identifier for an order. GetOrders GetOrderTransactions Conditionally A unique identifier for an order. The set of valid states for an order. (out) Active order status. (out) Inactive order status. (out) Completed order status. (out) Cancelled order status. (out) Reserved for internal or future use Contains a list of orders, transactions, or both, each of OrderTransactionType. The individual order or transaction. GetMyeBayBuying Conditionally WonList GetMyeBaySelling Conditionally Contains an order or a transaction. A transaction is the sale of one or more items from a seller's listing to a buyer. An order combines two or more transactions into a single payment. Contains the information describing an order. GetMyeBayBuying Conditionally WonList Contains the information describing a transaction. GetMyeBaySelling Conditionally A combination of two or more transactions that can be paid for with a single payment. We strongly recommend that you avoid mixing digital and non-digital listings in the same order. (In the future, AddOrder may enforce this recommendation. Unique identifier for the order. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none GetMyeBayBuying Conditionally WonList The current status of the order. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none Amount by which the buyer is adjusting the order total. Used when the seller has not supplied payment details such as shipping and handling or insurance fee. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none Amount the buyer has paid the seller for the order. For GetOrders, applies only to Half.com. GetOrders Always GetOrderTransactions Always none Amount the buyer saved by having multiple items combined into a single order, versus purchasing the items separately. GetOrders Always GetOrderTransactions Always none The current checkout status of the order. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none The shipping-related details for an item or transaction, including flat or calculated shipping costs and shipping insurance costs. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none AddOrder No Indicates whether the order is created by the buyer or by the seller. GetOrders Always GetOrderTransactions Always none AddOrder Yes Date and time the order was created. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none Specifies a promotional offer that allow the buyer to purchase items on credit. The payment methods the buyer uses to pay for the order. An order can have multiple payment methods if the buyer combines several transactions into one order. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none AddOrder No The email of the order's seller. Shipping address the order has been or will be sent to. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none The shipping service selected by the buyer from the services offered by the seller. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none The sum of the sale prices of all of the transactions in the order, where a transaction sale price is the item sale price times the quantity sold. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none GetMyeBayBuying Conditionally WonList Subtotal plus the shipping cost plus the sales tax plus cost of insurance. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none AddOrder Yes Not applicable to Half.com. A PayPal transaction that relates to this eBay transaction. Returned only if there is at least one PayPal transaction related to this eBay transaction. GetOrderTransactions Conditionally none, ReturnAll Indicates whether the order contains at least one transaction for a digital listing. Not applicable to Half.com. GetOrders Conditionally GetOrderTransactions Always none The set of two or more transactions that make up the order. Also applicable to Half.com (for GetOrders). We strongly recommend that you avoid mixing transactions for digital and non-digital listings in the same order. (In the future, AddOrder may enforce this recommendation.) GetOrders Always GetOrderTransactions none Always GetMyeBayBuying Conditionally WonList AddOrder Yes User ID of the order's buyer. Not applicable to Half.com. GetOrders Always GetOrderTransactions none Always Contains a paginated list of items. Contains a list of Item types. GetMyeBayBuying Conditionally BidList BestOfferList LostList WatchList none, ReturnSummary, ReturnAll GetMyeBaySelling Conditionally Provides information about the list, including number of pages and number of entries. GetMyeBayBuying Conditionally BidList LostList WatchList WonList none, ReturnSummary, ReturnAll GetMyeBaySelling Conditionally Contains a paginated list of orders, transactions, or both, with each item an OrderTransactionType. Contains the list of orders, transactions, or both. GetMyeBayBuying Conditionally WonList GetMyeBaySelling Conditionally SoldList Specifies information about the list, including number of pages and number of entries. GetMyeBayBuying Conditionally WonList (out) Contains a paginated list of transactions. (out) Contains a list of transactions. Returned as an empty tag if no applicable transactions exist. GetItemsAwaitingFeedback Always (out) Provides information about the list of transactions, including number of pages and number of entries. GetItemsAwaitingFeedback Always (out) Shows the pagination of data returned by requests. Pagination of returned data is not needed in and not supported for every call. See the documentation for individual calls to determine whether pagination is supported, required, or desirable. (out) Indicates the total number of pages of data that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no pages are available. GetAccount GetCategoryListings GetItemsAwaitingFeedback GetMemberMessages GetOrders GetSearchResults GetSellerPayments GetWantItNowSearchResults Always ReturnSummary, ReturnAll, none GetUserDisputes Always ReturnSummary, ReturnAll, none GetItemTransactions GetSellerTransactions Always none, ItemReturnDescription, ReturnAll GetSellerList Always none, ItemReturnDescription, ReturnAll GetLiveAuctionBidders GetMyeBaySelling GetPopularKeywords Conditionally GetMyeBayBuying Conditionally BidList BestOfferList LostList WatchList WonList none, ReturnSummary, ReturnAll (out) Indicates the total number of entries that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no entries are available. GetSellerList Always none, ItemReturnDescription, ReturnAll GetCategoryListings GetItemsAwaitingFeedback GetLiveAuctionBidders GetMemberMessages GetOrders GetSearchResults GetSellerPayments GetWantItNowSearchResults Always GetItemTransactions GetSellerTransactions Always none, ItemReturnDescription, ReturnAll GetLiveAuctionBidders GetMyeBaySelling GetPopularKeywords Conditionally GetMyeBayBuying Conditionally BidList BestOfferList LostList WatchList WonList none, ReturnSummary, ReturnAll Specifies the payment status of a transaction, as seen by the buyer and seller. The buyer has not completed checkout, but has not paid through PayPal or PaisaPay. The buyer might have paid using another method, but the payment might not have been received or cleared. The buyer has not completed the checkout process and so has not made payment. The buyer has made a PayPal payment, but the seller has not yet received it. The buyer has made a PayPal payment, and the payment is complete. The transaction is marked as paid by either buyer or seller. The buyer has made an escrow payment, but the seller has not yet received it. The buyer has made an escrow payment, and the seller has received payment. The buyer has made an escrow payment, but has cancelled the payment. The buyer has paid with PaisaPay, but the payment is still being processed. The seller has not yet received payment. The buyer has paid with PaisaPay, and the payment is complete. The buyer has made a payment other than PayPal, escrow, or PaisaPay, but the payment is still being processed. Reserved for future use. PayPal account level. Account unverified Account international unverified Account verified Account international verified Account trusted Reserved for internal or future use PayPal account status. Account is active. Account is closed. Account is highly restricted. Account restriction is low. Account is locked. Reserved for internal or future use PayPal account type. Personal account. Premier account. Business account. Reserved for internal or future use Data associated with payment (payment durations). Applies to US eBay Motors site (except Parts and Accessories category). Number of hours after a listing closes that the buyer can put down a deposit on an item. The choices are 24, 48, and 72, and the default is 48. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem Conditionally Applies to US eBay Motors site (except Parts and Accessories category) and eBay Canada site for motors. Number of days after a listing closes that the buyer can take to pay for the item. The choices are 3, 7, 10, and 14, and the default is 7. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem Conditionally Used for specifying items for which a specific payment method or methods are accepted. PayPal payment method. PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203). Either the PayPal or the PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203). Details about a specific payment option. A payment method value defined in the schema. Related fields: Item.PaymentMethods in AddItem PaymentMethodUsed in ReviseCheckoutStatus GeteBayDetails Conditionally Full name of the payment method for display purposes. GeteBayDetails Conditionally Indicates the success or failure of the buyer's online payment for a transaction. (out) No payment failure. (out) The buyer's eCheck bounced. (out) The buyer's credit card failed. (out) The seller reports that the buyer's payment failed. (out) The payment from buyer to seller is in PayPal process, but has not yet been completed. (out) Reserved for internal or future use For GetSellerPayments, indicates the type of Half.com payment being made (sale or refund). (in) The buyer paid the seller. Also applicable to Half.com. GetSellerPayments Conditionally (in) The seller issued a refund to the buyer. Also applicable to Half.com. GetSellerPayments Conditionally For eBay internal use. For eBay internal use. All other payment types. (out) Reserved for internal or future use. Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS). Cannot be used with Listing Designer layouts (specified in Item.ListingDesigner). (in/out) No special image display options. Valid for US Motors listings. AddItem RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetItem GetMyeBayBuying GetMyeBaySelling GetSearchResults Conditionally (in/out) Display multiple pictures in a slideshow format. Only available for site-hosted pictures. Deprecated with a compatibility level of 381. Use SiteHostedPictureShow or VendorHostedPictureShow instead. Not valid for US Motors listings. AddItem RelistItem ReviseItem VerifyAddItem No Deprecated GetBidderList GetCategoryListings GetItem GetMyeBayBuying GetMyeBaySelling GetSearchResults Conditionally Deprecated (in/out) Increase the size of each image and allow buyers to enlarge images further. Only available for site-hosted images. Not valid for US Motors listings. AddItem RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetItem GetMyeBayBuying GetMyeBaySelling GetSearchResults Conditionally (in/out) Increase the number of images displayed. Only available for site-hosted images. Valid for US Motors listings. AddItem RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetItem GetMyeBayBuying GetMyeBaySelling GetSearchResults Conditionally (in/out) Display multiple, site-hosted pictures in a slideshow format. AddItem RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetItem GetMyeBayBuying GetMyeBaySelling GetSearchResults Conditionally (in/out) Display multiple, vendor-hosted pictures in a slideshow format. Not valid for US Motors listings. AddItem RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetItem GetMyeBayBuying GetMyeBaySelling GetSearchResults Conditionally (in/out) Display multiple, super-size, site-hosted pictures in a slideshow format. Valid for US Motors listings. AddItem RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetItem GetMyeBayBuying GetMyeBaySelling GetSearchResults Conditionally (out) Reserved for internal or future use. Contains the data for a picture associated with an item. Replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with compatibility level 439 or greater. With the future deprecation of SiteHostedPicture and VendorHostedPicture as input, applications should use PictureDetails in the input instead. Not applicable to Half.com. 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. If the value is Gallery, Plus, or Featured, eBay checks the available image URLs in the following order to determine which URL to use (if more than one of these URLs is available): a) Use the URL in GalleryURL, if it is specified. b) Otherwise, if ProductListingDetails.UseStockPhotoURLAsGallery is true, use the eBay stock photo. c) Otherwise, use the value of the first PictureURL in the array of PictureURL fields, if any. d) Otherwise, if ProductListingDetails.ProductID is specified, use the eBay stock photo for that ProductID (eBay resets UseStockPhotoURLAsGallery to true in this case). e) If eBay is unable to find an image URL for the listing, an error is returned. Note that the Gallery Plus feature requires that the image be hosted with the eBay Picture Service (EPS). One EPS image is included at no cost with the Gallery Plus feature. See "Describing Items in a Listing" in the eBay Web Services Guide for additional information about working with pictures and related validation rules. You cannot remove Gallery, Plus, or Featured when revising or relisting, however you can upgrade to a higher feature. On upgrade, the original feature fee is credited, and the new feature fee is charged. AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Describing Items in a Listing http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DescribingItems URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. For eBay Live Auctions, lots are listed in the gallery for free. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. If the value of GalleryType is Gallery or Plus or Featured, 1024 AddItem GetItemRecommendations AddLiveAuctionItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally GetMyeBayBuying Conditionally BidList SecondChanceOffer GetItem Always none, ItemReturnDescription, ReturnAll Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL. Cannot be used in combination with Listing Designer layouts. Specify None or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Contains the URL for an image associated with the item. Images can be hosted by eBay Picture Services (EPS) (or by eBay Picture Manager) or they can be self-hosted. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL value. If specified, this cannot have an empty/null value. To specify multiple pictures, send each URL in a separate, adjacent PictureURL element. In most cases, the image at the first URL is also used for the picture at the top of the View Item page on the Web site. On the main eBay site, a listing can have a maximum of 12 picture URLs hosted by eBay Picture Services or a maximum of 6 picture URLs hosted by a third-party vendor. If you specify multiple vendor-hosted pictures in listing calls, PhotoDisplay must be set to VendorHostedPictureShow. You cannot mix vendor-hosted and site-hosted pictures within the same listing. On the US eBay Motors site (for all vehicle listings), and on the eBay Canada site for motors, the picture pack of a listing can contain up to 24 photos. On the eBay Live Auctions site, a listing can have a maximum of 5 picture URLs hosted by eBay Picture Services or a third party. If you embed pictures in the description (by using IMG tags) instead of using PictureURL, but you want a camera icon to appear in search and listing pages, specify the following "clear image" URL in PictureURL: http://pics.ebay.com/aw/pics/dot_clear.gif. This clear image is not supported for eBay Express. For VerifyAddItem, you can use the following fake eBay Picture Services URL (http://i2.ebayimg.com/abc/M28/dummy.jpg) to verify that your application is obtaining the correct fees for the quantity of images you pass in. To remove a picture when revising or relisting an item, specify PictureDetails with all the pictures that you want the listing to include. That is, you need to completely replace the original set of URLs with the revised set. To remove all pictures from a listing, specify item.PictureDetails.PictureURL in DeletedField. 150 AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally GetItem Conditionally none, ItemReturnDescription, ReturnAll The service hosting the images in PictureURL, if any. This information is primarily useful for Picture Manager subscribers, who pay a flat subscription fee instead of individual picture fees per listing. Only returned when PictureURL is returned. GetItem Conditionally ReturnAll Specifies an action to be performed on a folder or setting in the user's Picture Manager account. (in) Adds a folder, picture, or setting to the account. (in) Deletes a folder, picture, or setting from the account. (in) Renames a folder or picture. (in) Moves a picture to another folder. (in) Changes a subscription level. (out) Reserved for internal or future use Specifies a detail level for a response to a Picture Manager call. Use a value for this element, rather than a value for DetailLevel. (in) All pictures, folders, and account settings. Default value. (in) Only data about the account subscription. (in) Return only data about pictures and folders in the authenticated user's account. (out) Reserved for internal or future use The level of Picture Manager subscription. Each level has a monthly fee and provides a certain amount of storage space. GetPictureManagerDetails none, ReturnSubscription, ReturnAll Always The amount of storage already in use. Measured in bytes. Read-only value. GetPictureManagerDetails none, ReturnSubscription, ReturnAll Always The amount of storage space remaining in the authenticated user's album. Measured in bytes. Read-only value. GetPictureManagerDetails none, ReturnSubscription, ReturnAll Always Whether to keep a copy of the original picture without resizing. Default is false. true = keep originals. GetPictureManagerDetails none, ReturnPicture, ReturnAll Always Whether to show the EPS watermark when photos are displayed. Default is false. true = show. GetPictureManagerDetails none, ReturnPicture, ReturnAll Always Whether to show the user ID watermark when photos are displayed. Default is false. true = show. GetPictureManagerDetails none, ReturnPicture, ReturnAll Always The folder requested in the album. GetPictureManagerDetails none, ReturnPicture, ReturnAll Always SetPictureManagerDetails Yes A folder in the authenticated user's album. By default, all folders and their pictures are returned. If a folder ID is specified, the folders' metadata and contents are returned. The ID of the folder. GetPictureManagerDetails none, ReturnPicture, ReturnAll Always SetPictureManagerDetails Yes The name of the folder. 55 GetPictureManagerDetails none, ReturnPicture, ReturnAll Always SetPictureManagerDetails Yes A picture within the folder, identified by a name, date, URL, and other metadata. GetPictureManagerDetails none, ReturnPicture, ReturnAll Conditionally SetPictureManagerDetails Conditionally Defines various styles of picture display for images in Picture Manager albums. The style of picture display, with a maximum size. GetPictureManagerOptions Always GetPictureManagerDetails none, ReturnPicture, ReturnAll Conditionally SetPictureManagerDetails Conditionally The URL to the image in the Picture Manager album. GetPictureManagerDetails none, ReturnPicture, ReturnAll Conditionally SetPictureManagerDetails Conditionally The total file size of the picture, in bytes. GetPictureManagerDetails none, ReturnPicture, ReturnAll Conditionally SetPictureManagerDetails Conditionally The height of a specific image, or the maximum allowed height, in pixels. Varies for different calls. GetPictureManagerOptions Always GetPictureManagerDetails none, ReturnPicture, ReturnAll Conditionally SetPictureManagerDetails Conditionally The width of a specific image, or the maximum allowed width, in pixels. Varies for different calls. GetPictureManagerOptions Always GetPictureManagerDetails none, ReturnPicture, ReturnAll Conditionally SetPictureManagerDetails Conditionally Specifies the types of images that can be stored in a Picture Manager album. (in/out) A small image, thumbnail size. Maximum size 96 pixels. (in/out) A BIBO image. Maximum size 200 pixels. (in/out) A standard size image. Maximum size 400 pixels. (in/out) A large image. Maximum size 500 pixels. (in/out) A very large image. Maximum size 800 pixels. (in/out) The original uploaded image. (out) Reserved for internal or future use A picture in a Picture Manager album. The URL that identifies the picture in the album. If a URI has spaces, replace them with %20. The name of the picture, specified by the user. GetPictureManagerDetails none, ReturnPicture, ReturnAll Conditionally SetPictureManagerDetails Conditionally The date the picture was uploaded to the Picture Manager account. GetPictureManagerDetails none, ReturnPicture, ReturnAll Conditionally SetPictureManagerDetails Conditionally The type of picture display in Picture Manager. GetPictureManagerDetails none, ReturnPicture, ReturnAll Conditionally SetPictureManagerDetails Conditionally Specifies the level of the authenticated user's Picture Manager subscription. (in/out) Free to Stores users. (in/out) 10 MB of storage. (in/out) 50 MB of storage. (in/out) 125 MB of storage. (in/out) 300 MB of storage. (out) Reserved for internal or future use Describes one type of Picture Manager subscription that is available. The level of the subscription. GetPictureManagerOptions Always The monthly fee for the subscription. Read-only value. GetPictureManagerOptions Always The total amount of storage space available for the subscription type. Read-only value. GetPictureManagerOptions Always Specifies the service that is used to host a listing's pictures. (out) The PictureURL images are hosted by eBay Picture Services and the seller is not a Picture Manager subscriber. (out) The PictureURL images are hosted by eBay Picture Manager and the seller is a Picture Manager subscriber. (out) The PictureURL images are not hosted by eBay. (Only applicable to PictureDetails. Not applicable to SiteHostedPicture.) (out) Reserved for internal or future use One of the data filters used when searching for items using GetSearchResults. Allows filtering based on the current price of items. Properties allow for defining a range within prices must fall to be returned in the result set, a minimum price for items returned, or a maximum price for items returned. Specifies the maximum current price an item listing can have to be included in the searches result set. Use alone to specify a maximum price or with MinPrice to define a range the items' prices must be. See "Data Types" in the eBay Web Services Guide for information about specifying double values. GetSearchResults No Specifies the minimum current price an item listing can have to be included in the searches result set. Use alone to specify a minimum price or with MaxPrice to define a range the items' prices must be. See "Data Types" in the eBay Web Services Guide for information about specifying double values. GetSearchResults No Pricing data returned from the Product Pricing engine. A product's pricing data (if any) and brief information about the product. GetItemRecommendations Conditionally Defines the ProPack feature (a feature pack). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Defines the ProPackPlus feature (a feature pack). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Details about ProStores and checkout preferences. Indicates whether third party checkout was enabled for ProStores. GetUserPreferences Conditionally Details about the store. GetUserPreferences Conditionally Details about the store. The username associated with the store. GetUserPreferences Conditionally The name of the store. GetUserPreferences Conditionally The status--whether enabled or disabled. GetUserPreferences Conditionally Container for a list of eBay Express products. Can contain zero, one, or multiple ExpressProductType objects, each of which conveys the data for one product. Contains the data properties that define one eBay catalog product that matches the request, if any. GetSearchResultsExpress only returns products when matching products are found. For each product, the set of fields returned is controlled by the value of ProductDetails in the request. Multiple Product nodes can be returned (up to the amount specified in EntriesPerPage). GetSearchResultsExpress Conditionally A set of results returned from a catalog product search. Use GetProductSearchResults or GetProductFamilyMembers to perform the search. See the guide for information about Pre-filled Item Information (Catalogs) functionality. A transient header that describes the current search results. Contains a an ID, a subset of attributes, and a typical stock photo to help a user easily distinguish the products in the current result set from products in other result sets returned in the same response. One ParentProduct is returned per ProductFamily. GetProductFamilyMembers GetProductSearchResults Always A set of products (within the same product family) that match the search query. GetProductFamilyMembers GetProductSearchResults Always If true, the product family has more products than you requested in MaxChildrenPerFamily for a query in the GetProductSearchResults request. In this case, no products are returned in the GetProductSearchResults response. (Call GetProductFamilyMembers to retrieve all products in the family.) If false, the product family has MaxChildrenPerFamily or fewer product children, and the call returns all products in the family. GetProductFamilyMembers GetProductSearchResults Always An attribute (constraint) that was specified in a search request that was based on a product finder query. Used to help you map each query in a batch request to the corresponding search result in the response. The search attribute name (e.g., Manufacturer). GetProductSearchResults Conditionally The search attribute value the user specified in the query (e.g., the actual name the user chose for the manufacturer). GetProductSearchResults Conditionally The average start price (minimum bid), if any, of completed auction items that were listed with Pre-filled Item Information from this product. GetItemRecommendations Conditionally PricingRecommendations The average sold price (winning bid, Buy It Now price, or fixed price), if any, of completed items that were listed with Pre-filled Item Information from this product. GetItemRecommendations Conditionally PricingRecommendations Title associated with the product. This value can be used as the basis for a suggested listing title. If the title is longer than 55 characters, your application should make sure the suggested title has a max length of 55 characters so that it will be valid for the AddItem family of calls. 1024 GetItemRecommendations Conditionally Unique identifier for the product. See the Developer's Guide for information about eBay product IDs. If the primary and secondary category are both catalog-enabled, this ID corresponds to the primary category. 4000 GetItemRecommendations Conditionally Contains product information that can be included in a listing. Applicable for listings that use eBay's Pre-filled Item Information feature. See the Developer's Guide for details on working with Pre-filled Item Information. Applicable when ProductListingDetails is used. Unique identifier for the product. See the Developer's Guide for information about determining product IDs. If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category). In item-listing requests, if you pass in an old product ID, eBay will list the item with the latest version of the product and the latest product ID, and the call will return a warning indicating that the data has changed. To list an item with Pre-filled Item Information by using an ISBN, EAN, or UPC value, use ExternalProductID (defined on AddItem) instead. Either ExternalProductID (for an ISBN, UPC, EAN or eBay product ID) or Item.ProductListingDetails.ProductID (for an eBay product ID) can be specified in AddItem requests, but not both. 4000 AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll If true, indicates that the item listing includes the stock photo. To use an eBay stock photo in an item listing, set IncludeStockPhotoURL to true. If a stock photo is available, it is used at the top of the View Item page and in the Item Specifics section of the listing. If you also include Item.PictureDetails.PictureURL, the stock photo only appears in the Item Specifics section of the listing. Other pictures you specify by using Item.PictureDetails.PictureURL appear in a separate section of the listing. If you use Item.ExternalProductID instead of Item.ProductListingDetails, eBay sets IncludeStockPhotoURL to true (and you cannot set it to false). In GetItem, the URL of the stock photo will be returned in StockPhotoURL. If you set IncludeStockPhotoURL to false, the stock photo does not appear in the listing at all. To be considered for eBay Express, in most cases a listing must include a picture or a gallery URL. You can choose to use the eBay stock photo for this purpose. See "Working with eBay Express Listings" in the eBay Web Services Guide. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll If true, specifies that the listing should include additional information about the product, such as a publisher's description or film credits. Such information is hosted through the eBay site and cannot be edited. If true, Item.Description is optional in item-listing requests. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll If true, indicates that the stock photo for an item (if available) is used as the gallery thumbnail. When listing an item, IncludeStockPhotoURL must also be true and Item.PictureDetails.GalleryType must be passed in with a value of Gallery or Gallery Featured (but not both). Passing in Item.PictureDetails.GalleryURL takes precedence over UseStockPhotoURLAsGallery. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules for pictures. If you use Item.ExternalProductID instead of Item.ProductListingDetails, eBay sets UseStockPhotoAsGallery to true (and you cannot set it to false). To be considered for eBay Express, in most cases a listing must include a picture or a gallery URL. You can choose to use the eBay stock photo for this purpose. See "Working with eBay Express Listings" in the eBay Web Services Guide. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll Fully qualified URL for a standard image (if any) that is associated with the product. A seller can choose to include the stock photo in the listing and as the gallery thumbnail by setting IncludeStockPhotoURL and UseStockPhotoURLAsGallery to true. Output only. GetBidderList Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItem Conditionally ItemReturnAttributes, ReturnAll Copyright statement indicating the source of the product information. This information will be included in the listing with Pre-filled Item Information. Your application should also display the copyright statement when rendering the Pre-filled Item Information. If more than one copyright statement is applicable, they can be presented to the user in alphabetical order. Returned as HTML. Output only. GetBidderList Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll A list of products returned from the Suggested Attributes engine. A suggested product to use to list an item with Pre-filled Item Information. Returned from GetItemRecommendations when the Suggested Attributes engine is used See the Developer's Guide for additional details. GetItemRecommendations Conditionally Replaced by DataElementSet.DataElement as of release 449. This field is still returned for backward compatibility, but it may be deprecated in a future release. Applications should remove dependencies on this element and start using DataElementSet.DataElement instead. GetProductSearchPage ReturnAll Always Deprecated A list of attributes that describe the choice of search criteria for the specified characteristic set. The order in which the criteria are returned is not significant and may vary for different requests. See the eBay Web Services guide for details about how to use this data as input to GetProductSearchResults. GetProductSearchPage ReturnAll Always Indicates whether one attribute or multiple attributes can be used as the search keyword when calling GetProductSearchResults. Applications can ignore this data because GetProductSearchPage only supports single-attribute searches. Use GetProductFinder to determine valid multi-attribute searches. GetProductSearchPage ReturnAll Always A product aspect or feature that can be used as a key for sorting catalog search results. This does not necessarily match a searchable attribute. For example, you might be able to search on a product's title but sort the results by the release date or the manufacturer's suggested retail price (MSRP). At least one sort attribute is always returned. Applications should ensure that only one attribute is selected as a sort key from these results (before calling GetProductSearchResults). The default sort key is the one with the lowest DisplaySequence value. The order in which the SortCharacteristics nodes are returned is not significant and may vary for different requests. See the eBay Web Services guide for details about how to use this data as input to GetProductSearchResults. GetProductSearchPage ReturnAll Always Contains helpful hints for the user. Usage of this information is optional. GetProductSearchPage ReturnAll Always Container for the results of a product query. Supports Pre-filled Product Information functionality. See the Developer's Guide for more information about working with this data. (out) The approximate quantity of pages of results that match the product search query (TotalProducts divided by the median number of products per page examined so far). Lowest value is 1. For GetProductSearchResults, obsolete (not returned) with compatibility level 387 and higher. For GetProductFamilyMembers, obsolete (not returned) with compatibility level 415 and higher. Applications should remove dependencies on this field and use AttributeSet.ApproximatePages instead. (out) Constant value that identifies the attribute set in a language-independent way. Unique across all eBay sites. Corresponds to a characteristic set associated with the current set of search results. For GetProductSearchResults, obsolete (not returned) with compatibility level 387 and higher. For GetProductFamilyMembers, obsolete (not returned) with compatibility level 415 and higher. Applications should remove dependencies on this field and use AttributeSet.AttributeSetID instead. (out) If true, the query results contain additional pages (higher than the current page number). For GetProductSearchResults, obsolete (not returned) with compatibility level 387 and higher. For GetProductFamilyMembers, obsolete (not returned) with compatibility level 415 and higher. Applications should remove dependencies on this field and use AttributeSet.HasMore instead. (out) ProductFamilies represents one product family. Multiple ProductFamilies properties can be returned. A product family identifies a group of related products. For example, the movie "My Favorite Movie: The Sequel" might be released on DVD, but there might be several editions of the DVD (e.g., in different languages) with different ISBN numbers. All variations are part of the same product family ("My Favorite Movie: The Sequel" in the DVD format). For GetProductSearchResults, obsolete (not returned) with compatibility level 387 and higher. For GetProductFamilyMembers, obsolete (not returned) with compatibility level 415 and higher. Applications should remove dependencies on this field and use AttributeSet.ProductFamilies instead. A list of attributes (constraints) that were specified in the search request. This information is useful when multiple queries were specified in a GetProductSearchResults request. Use this information to map each query to each result in the response object. Applicable when the search request was constructed based on a product finder. For GetProductSearchResults, obsolete (not returned) with compatibility level 387 and higher. Applications should remove dependencies on this field and use AttributeSet.ProductFinderConstraints instead. Not applicable to GetProductFamilyMembers. (out) If too many search results match the query, the TooManyMatchesFound tag is returned with a warning. In this case, it may be a good idea to ask the user to specify more details to narrow the search (e.g., specify "My Favorite Movie" instead of "My"). For GetProductSearchResults, obsolete (not returned) with compatibility level 387 and higher. Applications should remove dependencies on this field and use AttributeSet.TooManyMatchesFound instead. Not applicable to GetProductFamilyMembers. (out) The total quantity of products that match the query (within the characteristic set). This can exceed the actual number of products returned in the current virtual page. For GetProductSearchResults, obsolete (not returned) with compatibility level 387 and higher. For GetProductFamilyMembers, obsolete (not returned) with compatibility level 415 and higher. Applications should remove dependencies on this field and use AttributeSet.TotalProducts instead. (out) Key you specified in ProductSearchID in the search request to distinguish between query results. Primarily useful when conducting multiple searches in the same call. If no ProductSearchID value was specified in the request, returns the array index of the search result (beginning with 0). Not applicable to GetProductFamilyMembers. GetProductSearchResults Always (out) Total quantity of products that match the search request (across all characteristic sets). This value can exceed the actual quantity of products returned in the current virtual page. Not applicable to GetProductFamilyMembers. GetProductSearchResults Always (out) A result containing a set of one or more product families. For GetProductSearchResults, if QueryKeywords and multiple characteristic set IDs were specified in the request, multiple AttributeSet objects can be returned. Each AttributeSet corresponds to a characteristic set ID specified in the request. See the eBay Web Services guide for more information about working with this data. For GetProductSearchResults, only returned with compatibility level 387 and higher. For GetProductFamilyMembers, only returned with compatibility level 415 and higher. For lower compatibility levels, see ProductSearchResult. GetProductFamilyMembers GetProductSearchResults Always (out) If true, your application should attempt to display stock photos that are returned. If false, your application should not attempt to display any stock photos that are returned. This recommendation is useful for catalog data related to products like coins, where stock photos are not applicable. An application with a graphical user interface can use this flag to determine when to hide stock photo widgets for a set of search results. GetProductFamilyMembers GetProductSearchResults Always Container for a product query and pagination instructions. This data is applicable when searching eBay catalogs for stock product information (to use in listings with Pre-filled Item Information.) Input only. Unique alphanumeric key help you distinguish between query results in the response. You define the key. Each search request ID must be unique within the same call. Primarily useful when conducting multiple searches in the same call. If not specified, the ProductSearchResult.ID values in the response are indexed starting from 0 (zero). GetProductFamilyMembers GetProductSearchResults No Identifier for a characteristic set (an attribute set) that is mapped to a catalog-enabled category (unique across all eBay sites). Required when you use SearchAttributes (for searches based on product search page and product finder data). Returns an error with QueryKeywords (use CharacteristicSetIDs instead). Use GetProductSearchPage or GetProductFinder to determine valid IDs for the type of search you are performing. GetProductFamilyMembers GetProductSearchResults Conditionally Required when you are performing a sell-side product finder search. (Not applicable to product search page searches.) Numeric identifier for a sell-side product finder that was used to retrieve the search attributes being used in the request. The product finder must be mapped to a catalog-enabled category (i.e., it cannot be a buy-side product finder ID) associated with the characteristics set. Use a product finder when you want to specify multiple attributes in a product search query. Call GetCategory2CS to determine which categories support sell-side product finder searches. GetProductSearchResults Conditionally Identifier for a representative stock product in a product family. Used as input in GetProductFamilyMembers requests to identify a product family. Use GetProductSearchResults to determine the available IDs. 4000 GetProductFamilyMembers Yes Unique identifier for a sortable attribute. Use GetProductSearchPage or GetProductFinder to determine the valid sort attribute IDs for the specified characteristic set (including the default sort attribute that will be used if you do not specify this field). GetProductFamilyMembers GetProductSearchResults No Pagination instruction that specifies the maximum quantity of products to return for each product family within the search response whose ID matches the current request's ID. In the response, if the last family returned contains MaxChildrenPerFamily or fewer additional products, those additional products are also returned (i.e., the actual quantity returned for the last family can exceed the specified maximum value). See "Limit the Quantity of Products Returned Per Family" in the eBay Web Services Guide. The value should not include punctuation (i.e., a thousands separator is not valid). GetProductSearchResults Conditionally 1 20000 5 A predefined attribute against which to search (e.g., Author). Use this to create a query based on a set of Item Specifics from the catalog. Both the product title and product Item Specifics are searched. If the query includes multiple SearchAttributes fields (one for each attribute), the search engine will apply "AND" logic to the query. Call GetProductSearchPage or GetProductFinder to determine the list of valid attributes and how many are permitted for the specified characteristic set. See the eBay Web Services guide for details. For each ProductSearch, either SearchAttributes or QueryKeywords is required (but do not pass both). GetProductSearchResults Conditionally Pagination instruction that specifies the virtual page of data to return per search request. Default page number is 0 (the first page). Specify a page number of 0 or a positive value lower than the approximate number of pages available. GetProductFamilyMembers GetProductSearchResults No Filter to only retrieve products that match active eBay listings. This may be used as an indicator to determine which products other sellers recently used to pre-fill similar listings. If true, only retrieve products that have been used to pre-fill active listings on the specified eBay site. If false, retrieve all products that match the query. GetProductSearchResults No false One or more keywords to search for in the characteristic set specified in CharacteristicSetIDs. Both the product title and Item Specifics are searched. For each ProductSearch, either SearchAttributes or QueryKeywords is required (but do not pass both). Blank searches are not applicable (and result in a warning). The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for products containing these words. To use AND or OR logic, use eBay's standard search string modifiers. Wildcards (+, -, or *) are also supported. Be careful when using spaces before or after modifiers and wildcards. 350 GetProductSearchResults Conditionally List of one or more characteristic set IDs that indicate which characteristic sets to search in. If not specified, the search is conducted across all characteristic sets. Only applicable when QueryKeywords is specified. Ignored when SearchAttributes is specified. GetProductSearchResults No A prototype description of a well-known type of item, such as a popular book. Applicable when working with eBay's Pre-filled Item Information feature. A set of characteristics that describe the product in a standardized way. In responses, only the attributes and values that applicable for the specified product are returned. GetProductFamilyMembers GetProductSearchResults Always GetProductSellingPages Yes Fully qualified URL for optional information about the product, such as a movie's description or film credits. This information is hosted through the eBay site and cannot be edited. Applications can include this URL as a link in product search results so that end users can view additional descriptive details about the product. GetProductFamilyMembers FamilyMembers Always GetProductSearchResults Always Total number of active listings on the specified eBay site that were pre-filled based on this product. GetProductSearchResults FamilyMembers Always 0 Lowest current price of active and ended listings on the specified eBay site that were pre-filled based on this product. The value is in the specified site's currency. GetProductSearchResults FamilyMembers Always 0.0 Highest current price of active and ended listings on the specified eBay site that were pre-filled based on this product. The value is in the specified site's currency. Round numbers (such as 15.0) may only show one zero after the decimal (as with any double in the schema). GetProductSearchResults FamilyMembers Always 0.0 Unique identifier for the product. The ID is defined in an eBay catalog. Product IDs may change over time. Therefore, use the catalog search calls (GetProductSearchResults and GetProductFamilyMembers) to update any product IDs that you store locally. 4000 GetProductFamilyMembers GetProductSearchResults Always GetProductSellingPages Yes Fully qualified URL for a standard image that is associated with the product, if available. Allows the user to preview the image from your application. A user can choose to include the stock photo in a listing. GetProductFamilyMembers GetProductSearchResults GetProductSearchPage Conditionally The name of the product, as defined within the catalog. Not necessarily the same as the "Title" attribute in the characteristics set meta-data, if any. On the eBay site, this title serves as the basis for the suggested item title (truncated to the max length permitted for Title in item-listing calls). Applications can use this value to supply a suggested listing title to users. GetProductFamilyMembers FamilyMembers Always GetProductSearchResults Always Specifies the context in which the product selling page is being called, which will imply certain validation rules. Use this code list to make sure you retrieve the appropriate version of product information and characteristic meta-data when you are listing an item with Pre-filled Item Information. (in) Use this code when calling GetProductSellingPages before adding an item. This retrieves the latest product ID and the corresponding characteristic meta-data. GetProductSellingPages Conditionally (in) Use this code when calling GetProductSellingPages before revising an item that already contains product information. If the product ID or data has changed, the original product ID that you passed in and the data associated with that original version of the product is returned. This is useful because the original Pre-filled Item Information is used when you call ReviseItem. GetProductSellingPages Conditionally (in) Use this code when calling GetProductSellingPages before relisting an item that already contains product information. This retrieves the latest product ID and the corresponding characteristic meta-data (same data as AddItem). GetProductSellingPages Conditionally (out) Reserved for internal or future use Contains the data describing one cross-promoted item. The unique ID of the cross-promoted item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetBidderList GetPromotionRules Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll SetPromotionRules Conditionally GetCrossPromotions Always URL for an image hosted by eBay Picture Services (EPS) or self-hosted for the promoted item, if any. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll For an item listed with multiple self-hosted pictures, contains the URLs of the self-hosted pictures in addition to the one listed in PictureURL. GetBidderList GetItem Conditionally (out) The ordinal position of the cross-promoted item in the display. If the display is from top to bottom, 1 is at top. If the display is from left to right, 1 is at left. Output only. GetBidderList GetPromotionRules Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll SetPromotionRules Conditionally GetCrossPromotions Always (out) The price of the cross-promoted item. Output only. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCrossPromotions Always The listing type for the promoted item and how the item price is used, either AuctionPrice or BuyItNowPrice. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCrossPromotions Always (out) The manner in which the cross-promoted item was chosen to be associated with the referring item. Output only. GetBidderList GetPromotionRules Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCrossPromotions Always (out) The title of the promoted item for display in the referring item's page. Output only. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCrossPromotions Always (out) The listing type under which the cross-promoted item is being offered. Output only. GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetCrossPromotions Always PromotionItemPriceTypeCodeType - Type declaration to be used by other schema. Indicates the type of offer that can be made for a cross-promoted item. Note that for a Chinese listing with a still-active Buy It Now option, either a Bid (Auction) or a Buy It Now type offer may be made. (out) Bid offer in a competitive-bidding listing. (out) Buy It Now offer in a fixed-price or Buy It Now listing. (out) Best Offer in Best Offer Only listing. Reserved for future use. (out) Reserved for internal or future use. PromotionItemSelectionCodeType - Type declaration to be used by other schema. Indicates how the cross-promoted item was selected for association with the referring item. If the seller defined an item-to-item cross-promotion rule and the item was selected because of that rule, then "Manual" is returned. If the seller defined some other rule and the item was selected because of that rule (or the seller defined no rules that could be applied), then "Automatic" is returned. (out) Manual selection. (out) Automatic selection. (out) Reserved for internal or future use. Indicates the type of cross-promotion used. (in/out) A cross-sell. The seller presents items that are related to or can be used with the item the buyer is bidding on or has purchased. (in/out) An upsell. The seller presents items that are higher quality or more expensive than the item the buyer is bidding on or has purchased. (in/out) Reserved for internal or future use. Contains a list of cross-promotion rules. Each PromotionRuleType defines one rule. Defines one cross-promotion rule. SetPromotionRules Yes GetPromotionRules Always Defines a rule that promotes items or a store category when a buyer views a specific item or store category. The unique item ID of the cross-promoted item. Use for an ItemToItem rule. SetPromotionRules Conditionally The site associated with the referring eBay category. Required only if the rule uses a referring eBay category. SetPromotionRules Conditionally The ID of the Store category being promoted. Use with a promotion scheme of ItemToStoreCat, StoreToStoreCat, ItemToDefaultRule, or DefaultRule. Only for Store owners. SetPromotionRules Conditionally GetPromotionRules Conditionally The ID of the eBay category being promoted. Use with a promotion scheme of ItemToDefaultRule or DefaultRule. SetPromotionRules Conditionally GetPromotionRules Conditionally The keywords that identify promoted items. Use with a promotion scheme of ItemToDefaultRule or DefaultRule. Only for Store owners. SetPromotionRules Conditionally GetPromotionRules Conditionally The unique ID of the item the buyer is viewing or purchasing. Use with a promotion scheme of ItemToItem or ItemToStoreCat. Always use ReferringItemID or ReferringStoreCategoryID, but not both. SetPromotionRules Conditionally GetPromotionRules Conditionally The ID of the store category the user is browsing. Use with a promotion scheme of StoreToStoreCat, ItemToDefaultRule or DefaultRule. Always use ReferringStoreCategoryID or ReferringItemID, but not both. SetPromotionRules Conditionally GetPromotionRules Conditionally The ID of the eBay category being referred. Use with a promotion scheme or ItemToDefaultRule or DefaultRule. SetPromotionRules Conditionally GetPromotionRules Conditionally The keywords that identify referring items. Use with a promotion scheme of ItemToDefaultRule or DefaultRule. Only for Store owners. SetPromotionRules Conditionally GetPromotionRules Conditionally The type of cross-promotion scheme you are defining. SetPromotionRules Yes GetPromotionRules Always The type of cross promotion, CrossSell or UpSell. SetPromotionRules Yes GetPromotionRules Always Identifies the scheme used for a cross-promotion rule. The scheme defines referring and promoted items and categories. To define a rule scheme, you must be the owner of an eBay Store. (in/out) The seller specifies individual items in the store that are promoted when a buyer views, bids on, or purchases a store item. (in/out) The seller specifies a store category from which items are promoted when a buyer views, bids on, or purchases an individual item in the store. (in/out) The seller specifies referring and promoted categories, both from the store. When a buyer views or acts on any item from that category, items from the promoted category are also displayed. (in/out) The seller specifies a referring item and defines promoted items selected from a store category, eBay category, or keywords. (in/out) The seller specifies a store category or eBay category, with optional keywords, for referring items and one for promoted items. When a referring item is selected from the category and keywords, items from the promoted category and keywords are also displayed. (out) This scheme is returned as a backfill scheme used to promote items. (out) Reserved for internal or future use. Contains information for use in proximity search. The postal code where the item is located. This response element is deprecated and may be removed from the schema in a future release. Remove application dependencies on this element. For item location, refer to Item.PostalCode instead. GetSellerList Conditionally ItemReturnDescription, ReturnAll Deprecated GetBidderList Always Deprecated GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Deprecated Contains data for filtering a search by proximity. The maximum distance from the specified postal code to search for items. GetSearchResults GetCategoryListings No The postal code to use as the basis for the proximity search. GetSearchResults GetCategoryListings No The purpose of a purchase (e.g., by a PayPal application). Custom Code (out) Reserved for internal or future use Used by QuantityOperator to specify that you are seeking quantities less than Quantity. Used by QuantityOperator to specify that you are seeking quantities less than or equal to Quantity. Used by QuantityOperator to specify that you are seeking quantities equal to Quantity. Used by QuantityOperator to specify that you are seeking quantities greater than Quantity. Used by QuantityOperator to specify that you are seeking quantities greater than or equal to Quantity. Reserved for internal or future use. General questions about the item. Questions related to the shipping of the item. Questions related to the payment for the item. Questions related to the shipping of this item bundled with other items also purchased on eBay. Not available. The status of a payment. Payment is in canceled state. Payment is in completed state. GetSellerPayments No Payment is in pending state. GetSellerPayments No (out) Reserved for internal or future use. GetSellerPayments No Type declaration to be used by other schema. Indicates that the data represents the high or low end in a range, such as a date range, price range, or width range. (For example, when calling GetProductSearchResults, you use range codes to indicate the role of an attribute in a range.) High end of the range. Low end of the range. (out) Reserved for internal or future use. A seller can make a Transaction Confirmation Request (TCR) for an item. This code list contains values to specify the current relationship between the seller and the potential buyer. For a seller to make a Transaction Confirmation Request (TCR) for an item, the potential buyer must meet one of the criteria in this code list. Indicates that the recipient has one or more bids on the item; the relationship is "bidder." Indicates that the recipient has one or more best offers on the item; the relationship is "best offer buyer." Indicates that the recipient has asked the seller a question about the item; the relationship is "a member with an ASQ question." Indicates that the recipient has a postal code; the relationship is "a member with a postal code." Reserved for internal or future use. RecommendationEngineCodeType - Type declaration to be used by other schema. Identifies the engines that can be used to analyze proposed listing data. See the Developer's Guide for a list of recommendation engines that are currently operational. (in) Listing Analyzer engine; Returns tips related to fields that a seller wants to specify in a listing. (in) Reserved for internal or future use. (in) Product Pricing engine. Returns average start and sold prices of completed items that were listed a specified product ID. (out) Reserved for internal or future use. (in) Suggested Attributes engine. Returns suggested Item Specifics and catalog products (for Pre-filled Item Information) that have been used by other sellers who listed similar items in the same category. Explanation of the reason that the refund is being issued. Applicable to Half.com refunds only. Seller is unable to ship the product to the buyer. Seller shipped the wrong item to the buyer. The buyer returned the item due to its quality. The buyer returned the item due to damage. The buyer decided they did not want the item. (out) Reserved for internal or future use. Explanation of the reason that the refund is being issued. Applicable to Half.com refunds only. The seller has issued a refund for the transaction price that was originally paid to the seller. (The seller's shipping reimbursement is not included if Half.com calculates the refund amount). The seller has issued a refund for the transaction price and shipping reimbursement that was originally paid to the seller. (The buyer's return shipping costs might not be included if Half.com calculates the refund amount.) The seller has issued a refund amount that is different from the full refund (with or without shipping). If specified, it may be helpful to explain the amount in your note to the buyer. (out) Reserved for internal or future use. Details about a region. Numeric identifier for a region within a country. Related field: Item.RegionID in GetItem (Ignore region values for all sites except China.) GeteBayDetails Conditionally Full name of the region. GeteBayDetails Conditionally Specifies how to return certain reminder types from the user's My eBay account. (in) The length of time the reminder has existed in the user's My eBay account, in days. Valid values are 1-60. GetMyeBayReminders No (in) Whether to include information about this type of reminder in the response. When true, the container is returned with default input parameters. GetMyeBayReminders No Specifies the type of reminders for which you want information. (out) The number of reminders requesting that the buyer send payment. GetMyeBayReminders Conditionally BuyingReminders (out) The number of reminders that feedback has not yet been received by the buyer or seller. GetMyeBayReminders Conditionally (out) The number of reminders that feedback has not yet been sent by the buyer or seller. GetMyeBayReminders Conditionally (out) The number of reminders advising the buyer that the buyer has been outbid. GetMyeBayReminders Conditionally BuyingReminders (out) The number of reminders that the seller has not yet received a payment. GetMyeBayReminders Conditionally SellingReminders (out) The number of reminders requesting that the seller review second chance offers. GetMyeBayReminders Conditionally SellingReminders (out) The number of reminders advising the seller that shipping is needed. GetMyeBayReminders Conditionally SellingReminders (out) The number of reminders advising the seller that relisting is needed. GetMyeBayReminders Conditionally SellingReminders A set of parameters that control the retrieval of categories (not items) that match a search query. In GetSearchResults, at least one child element must be specified in order to retrieve matching categories. If empty or not present, no matching category information is returned. . Filter to retrieve matching categories but not matching items or buying guides. If true, only matching categories are returned (with no item or buying guide details). If false or not present, matching items and matching categories are both returned, along with buying guide details (if any). If TotalOnly and Categories.CategoriesOnly are both specified in the request and their values are inconsistent with each other, TotalOnly overrides Categories.CategoriesOnly. That is, if TotalOnly is true and Categories.CategoriesOnly is false, the results include matching categories but no item data or buying guides. If TotalOnly is false and Categories.CategoriesOnly is true, the results include matching categories, item data, and buying guides. GetSearchResults No Maximum quantity of matching categories to return at the first level of the category hierarchy (CategoryLevel 1). 3 GetSearchResults No Maximum quantity of matching subcategories to return at each lower level of the hierarchy. 3 GetSearchResults No Filter to control the deepest matching category level to return. If you specify 0, no category data is returned. If you specify a negative number, the results are unpredictable. 2 1 GetSearchResults No A single set of one or more product families and related information returned in the results of a product search. Supports Pre-filled Item Information functionality. See the Developer's Guide for more information about working with this data. The approximate quantity of pages of results that match the product search query (TotalProducts divided by the median number of products per page examined so far). Always returned when AttributeSet is returned. For GetProductSearchResults, only returned with compatibility level 387 and higher. For GetProductFamilyMembers, only returned with compatibility level 415 and higher. With lower compatibility levels, ProductSearchResult.ApproximatePages is returned instead. GetProductFamilyMembers GetProductSearchResults Always 1 Numeric value that identifies the attribute set in a language-independent way. Unique across all eBay sites. Corresponds to a characteristic set associated with the current set of search results. Always returned when AttributeSet is returned. For GetProductSearchResults, only returned with compatibility level 387 and higher. For GetProductFamilyMembers, only returned with compatibility level 415 and higher. With lower compatibility levels, ProductSearchResult.AttributeSetID is returned instead. GetProductFamilyMembers GetProductSearchResults Always If true, the query results contain additional pages (higher than the current page number). You can retrieve more results by incrementing the PageNumber value that was passed in the request. For GetProductSearchResults, only returned with compatibility level 387 and higher. For GetProductFamilyMembers, only returned with compatibility level 415 and higher. With lower compatibility levels, ProductSearchResult.HasMore is returned instead. GetProductFamilyMembers GetProductSearchResults Always ProductFamilies represents one product family. Multiple ProductFamilies properties can be returned. A product family identifies a group of related products. For example, the movie "My Favorite Movie: The Sequel" might be released on DVD, but there might be several editions of the DVD (e.g., in different languages) with different ISBN numbers. All variations are part of the same product family ("My Favorite Movie: The Sequel" in the DVD format). See "Limit the Quantity of Products Returned Per Family" in the eBay Web Services Guide. Always returned when AttributeSet is returned. For GetProductSearchResults, only returned with compatibility level 387 and higher. For GetProductFamilyMembers, only returned with compatibility level 415 and higher. With lower compatibility levels, ProductSearchResult.ProductFamilies is returned instead. GetProductFamilyMembers GetProductSearchResults Always A list of attributes (constraints) that were specified in the search request. This information is useful when multiple queries were specified in a GetProductSearchResults request. Use this information to map each query to each result in the response object. Applicable when the search request was constructed based on a product finder. For GetProductSearchResults, only returned with compatibility level 387 and higher. With lower compatibility levels, ProductSearchResult.ProductFinderConstraints is returned instead. Not applicable to GetProductFamilyMembers. GetProductSearchResults Conditionally If too many search results match the query, the TooManyMatchesFound tag is returned with a value of true, and a warning is returned. If this occurs, it may be a good idea to ask the user to specify more details to narrow the search (e.g., specify "My Favorite Movie" instead of "My"). For GetProductSearchResults, only returned with compatibility level 387 and higher. With lower compatibility levels, ProductSearchResult.TooManyMatchesFound is returned instead. Returns false for GetProductFamilyMembers. GetProductFamilyMembers GetProductSearchResults Always The total quantity of products that match the query (within the characteristic set). This can exceed the actual number of products returned in the current virtual page. Always returned when AttributeSet is returned. For GetProductSearchResults, only returned with compatibility level 387 and higher. For GetProductFamilyMembers, only returned with compatibility level 415 and higher. With lower compatibility levels, ProductSearchResult.TotalProducts is returned instead. GetProductFamilyMembers GetProductSearchResults Always Contains data indicating whether an item has been revised since the listing became active and, if so, which among a subset of properties have been changed by the revision. Output only. If true, indicates the item was revised since the listing became active. Output only. GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally ItemReturnDescription, ReturnAll If true, indicates that a Buy It Now Price was added for the item. Only applicable to US eBay Motors items. Output only. GetBidderList GetItem Conditionally If true, indicates that the item's Buy It Now price was lowered. Only applicable to US eBay Motors items. Output only. GetBidderList GetItem Conditionally If true, indicates that the reserve price was lowered for the item. Only applicable to US eBay Motors items. Output only. GetBidderList GetItem Conditionally If true, indicates that the reserve price was removed from the item. Only applicable to US eBay Motors items. Output only. GetBidderList GetItem Conditionally Reserved for future use.. Reserved for future use. A list of stock-keeping unit (SKU) identifiers that a seller uses in listings. Identifier defined and used by a seller to identify an item. The seller can use a SKU to identify one item or use the same SKU for multiple items. Preferable to ApplicationData for SKUs and inventory tracking. Different sellers can use the same SKUs. This element can be used by sellers to track complex flows of products and information. This element preserves a SKU, enabling a seller to obtain it before and after a transaction is created. 50 GetSellerTransactions GetSellerList No Type that represents a stock-keeping unit (SKU). The seller can use a SKU to identify one item or use the same SKU for multiple items. Preferable to ApplicationData for SKUs and inventory tracking. Different sellers can use the same SKUs. This element can be used by sellers to track complex flows of products and information. This element preserves a SKU, enabling a seller to obtain it before and after a transaction is created. Type of SMS subscription error. Aggregator not available. Phone number invalid. Phone number has changed. The carrier has changed. The user has requested to be unregistered. (out) Reserved for internal or future use. (in/out) User data related to notifications. The wireless phone number to be used for receiving SMS messages. Max length of phone number varies by country. varies by country SetNotificationPreferences No GetNotificationPreferences Conditionally CN Registered/Unregistered/Pending. SetNotificationPreferences No GetNotificationPreferences Conditionally CN The wireless carrier ID. SetNotificationPreferences No GetNotificationPreferences Conditionally CN Reason for SMS subscription error (postback from thired-party integrator). SetNotificationPreferences No GetNotificationPreferences Conditionally CN ID of item to unsubscribe from SMS notification. SetNotificationPreferences No GetNotificationPreferences Conditionally CN The current state of user SMS subscription. (in) Registered. (in) Unregistered. (in) Pending subscription. (in) Subscription failed. (out) Reserved for internal or future use. Type for expressing sales tax data. Percent of an item's price to be charged as the sales tax for the transaction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). Also applicable to Half.com (for GetOrders). AddItem AddOrder GetItemRecommendations RelistItem ReviseItem SendInvoice VerifyAddItem No GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItemShipping GetTaxTable Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrders Always GetOrderTransactions Always none State or jurisdiction for which the sales tax is being collected. Also returned for Half.com (for GetOrders). AddItem AddOrder GetItemRecommendations RelistItem ReviseItem SendInvoice VerifyAddItem No GetBidderList GetItem GetItemShipping Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrders Always GetOrderTransactions Always none GetSellerList Conditionally ItemReturnDescription, ReturnAll (US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping. Also returned for Half.com (for GetOrders). AddItem AddOrder GetItemRecommendations RelistItem ReviseItem SendInvoice VerifyAddItem No GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItemShipping Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrders Always GetOrderTransactions Always none (US only) The amount of sales tax. Also returned for Half.com (for GetOrders). SendInvoice No GetBidderList GetItem GetItemShipping Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrders Always GetOrderTransactions Always none Sellers create live auction catalogs and schedule their live auction events by using the eBay Live Auctions Web site user interface. The seller can create a catalog in the Live Auctions system several months before a sale. Identifier for an event schedule in the seller's Live Auctions catalog. GetLiveAuctionCatalogDetails Conditionally Date and time that the sale schedule starts. GetLiveAuctionCatalogDetails Conditionally Contains information for scheduling limits for the user. Maximum number of minutes that a listing may be scheduled in advance of its going live. Output only. GetItem GetUser Conditionally Minimum number of minutes that a listing may be scheduled in advance of its going live. Output only. GetItem GetUser Conditionally Maximum number of Items that a user may schedule. Output only. GetItem GetUser Conditionally A product or item aspect or feature that can be used as a criterion in a search for catalog content or for listed items. For example, "Format" might be a criterion for searching the catalogs for Pre-filled Item Information related to hardcover books. Unique identifier for the attribute within the characteristic set. Required if SearchAttributes is specified. GetSearchResults Conditionally GetProductSearchResults Yes Specifies the date sub-component that the attribute represents. This only applies to date attributes. Required when searching by date attributes. Allows for separate text fields or drop-down lists to be rendered for each sub-component. For example, the day, month, and year can be rendered as separate drop-down lists. See DateSpecifierCodeType for possible values. GetSearchResults GetProductSearchResults Conditionally Indicates that the attribute represents the high or low end in a range, such as a date range or a price range. Required when searching on ranges. GetSearchResults GetProductSearchResults Conditionally Container for the list of one or more valid values that the user has selected for the searchable attribute. If multiple values are specified, the search engine applies "OR" logic to the query (i.e., at least one of the specified values must match). Required if SearchAttributes is specified. GetSearchResults GetProductSearchResults Yes Indicates whether a listing uses the Buy It Now feature. GetSearchResults Conditionally Indicates whether a listing has an image associated with it. GetSearchResults Conditionally Indicates whether a listing is no more than one day old. GetSearchResults Conditionally SearchFlagsCodeType - Search flags for GetSearchResults. Return only charity item listings. Include the description field of item listings in keyword search. Item listings returned are those where specified search keywords appear in the description, as well as the title and sub-title. Return only item listings where PayPal is a payment method offered by the seller. (in) Return only items that have been listed with Now and New. Applicable for certain sites only. See the Developer's Guide. (out) Reserved for internal or future use. One of the data filters used when searching for items using GetSearchResults. Allows filtering based on an item's location (where the seller would be shipping the item from) or an item's availability (which eBay sites the item can be purchased from). Country the item is either located in or available to (depending on the value specified in ItemLocation). GetSearchResults No Specifies whether the filter should be for items located in the country specified in Country or available to that country. GetSearchResults No Specifies filtering based on site ID. GetSearchResults No GetSearchResults No One of the data filters used when searching for items using GetSearchResults. Allows filtering based on the location of the item or its availability relative to an eBay site. Or allows for filtering based on regional listing. Specifies a region ID. The item must have been listed for the specified region to be returned in the search result set. GetSearchResults GetCategoryListings No Specifies a filter based on a particular eBay site and the item's relation to that site (items listed with a site's currency, items located in the country for the site, items available to the country for the site, and items listed on the specified site). GetSearchResults GetCategoryListings No Specifies a query consisting of attributes. Only attributes that are returned from GetProductFinder can be used. See the Developer's Guide for more information. Numeric identifier for a characteristic set that defines the attributes (unique across all eBay sites). GetSearchResults No Numeric identifier for a buy-side product finder. A product finder defines how to search for Item Specifics in listings (e.g., how to search against a particular shoe size). See the eBay Web Services guide for details about product finders. You need to specify a product finder ID when you are searching against a listing's Item Specifics (i.e., when you use SearchAttributes). A few categories, such as US Event Tickets and US eBay Motors, can also return a subset of Item Specifics (e.g., the event venue, section, and row for a ticket listing) in the search results. To retrieve this data, you must specify the product finder ID, and also specify a detail level of ItemReturnAttributes or ReturnAll. Use GetProductFinder to determine valid product finder IDs. GetSearchResults Conditionally A query consisting of a set of attributes (search criteria). If the query includes multiple attributes, the search engine will apply "AND" logic to the query. Use GetProductFinder to determine the list of valid attributes and how many are permitted for the specified characteristic set. If specified, ProductFinderID must also be specified. GetSearchResults No Container for a list of search result items, such as returned by GetSearchResults. Will contain zero, one, or multiple SearchResultItemType items, each of which represents one item listing that was found by the search. Output only. Contains data for an item listing found by a search. Output only. GetSearchResults Conditionally Contains the data for one item listing found by a search (such as by GetSearchResults). Contains summary data for the item listing itself, with the properties that define the listing. For all item data, use an item-retrieval call, such as GetItem. Output only. GetSearchResults Conditionally A list of attribute and value pairs. GetSearchResults can return this when the request either specifies IncludeCondition as true or specifies a product finder search by using SearchRequest. If IncludeCondition was true, this returns the item condition (e.g., New). If SearchRequest was used to perform a product finder search, the list is limited to attributes that would be included in the summary search results on the Web site, if any. In some categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.) GetSearchResults Conditionally Contains additional information about the item listing returned in Item. This information includes whether the item has an image associated with it, and more. May contain zero, one, or multiple SearchResultValuesCodeType values indicating different pieces of additional information about the listing. These values are analogous to the icons that appear in an item listing's line in a Search page. Output only. GetSearchResults Conditionally (out) Indicates items listed one day or less earlier than the current query. If the listing is no more than one day old, New returns a value of true. (out) Indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item purchase price to a selected nonprofit organization. Not applicable for eBay Motors, international sites, and Real Estate and Tickets listings. Determines the order in which items are returned when you use the GetSearchResults call. (in) Sorts items by the end date (items ending soonest). This is the default for most sites, except where noted for other values. (in) Sorts items by the start date (most recently listed first). (in) Sorts items by CurrentPrice (lowest bid first). Note that if an item was listed in a different currency from the site's currency, that item is sorted is based on its ConvertedCurrentPrice value. (It is a good idea to use SortByCurrentBidAsc instead.) (in) Sorts items by the listing date in descending order. (in) Sorts items by the current bid price in ascending order (lowest bid first). Note that if an item was listed in a different currency from the site currency, the item is sorted based on its ConvertedCurrentPrice value. (in) Sorts items by the current bid price in descending order (highest bid first). Note that if an item was listed in a different currency from the site's currency, the item is sorted based on its ConvertedCurrentPrice value. (in) Sorts items in ascending order based on whether PayPal is accepted (accepted followed by unaccepted). (in) Sorts items in descending order based on whether PayPal is accepted (unaccepted followed by accepted). (in) Sorts items in ascending order based on whether Escrow is applicable (applicable followed by inapplicable). (in) Sorts items in descending order based on whether Escrow is applicable (inapplicable followed by applicable). (in) Sorts items in ascending order by the country in which the items are located. (in) Sorts items in descending order by the country in which the items are located. (in) Sorts items based on distance from the buyer, with the nearest items returned first. (in) Sorts items based on the number of bids, fewest bids first. Applicable to China and Taiwan sites only. (in) Sorts items based on the number of bids, most bids first. Applicable to China and Taiwan sites only. (out) Reserved for internal or future use. One of the data filters used when searching for items using GetSearchResults. Allows filtering based on an item's appearing in a specific eBay Store. Name of the eBay Store the item must be listed in. GetSearchResults No Specifies the type of store search used in the filtering: one eBay Store (name specified in StoreName) or all eBay stores, and also by listing type. Possible values are enumerated in the StoreSearchCodeType code list. GetSearchResults No SearchTypeCodeType - Type declaration to be used by other schema. Identifies the SearchTypes (e.g., for GetSearchResults requests) used to restrict items returned to: only Gallery items or gallery and non-Gallery items. (in) Return Gallery and non-Gallery item listings. (in) Return Gallery items only. (out) Reserved for internal or future use. SecondChanceOfferDurationCodeType - Type declaration to be used by other schema. Specifies the number of days the second chance offer active. The recipient bidder must purchase the item within that time or the listing expires. The duration for a new second chance offer listing is limited to these values. (in) 1 Day. (in) 3 Days. (in) 5 Days. (in) 7 Days. (out) Reserved for internal or future use. This is automatic or manual depending on selection. Automatic criteria Manual criteria (out) Reserved for internal or future use Type of seller account. This value can be returned if the German site (site ID 77) or eBay Motors site (site ID 100) is specified. Type of seller account not defined. Private seller account. Commercial seller account. Reserved for future use. Contains the data for the seller favorite item preferences, i.e. the manual or automatic selection criteria to display items for buyer's favourite seller opt in email marketing. The keywords in the item title for the automatic item search criteria. GetUserPreferences Conditionally SetUserPreferences No (For eBay Store owners only) The store custom category for the automatic item search criteria. GetUserPreferences Conditionally SetUserPreferences No The listing format (fixed price, auction, etc) for the automatic item search criteria. GetUserPreferences Conditionally SetUserPreferences No The sort order chosen from the standard ebay sorts for the automatic search criteria. GetUserPreferences Conditionally SetUserPreferences No Specifies the lower limit of price range for the automatic search criteria. GetUserPreferences Conditionally SetUserPreferences No Specifies the upper limit of price range for the automatic search criteria. GetUserPreferences Conditionally SetUserPreferences No Specifies the list of favorite items. GetUserPreferences Conditionally SetUserPreferences No Maximum level of guarantee a seller is authorized to offer. (out) Not eligible for Seller Level Guarantee (out) Regular eligibility level (out) Premium eligibility level (out) Ultra eligibility level (out) Reserved for internal or future use. SellerLevelCodeType - Type declaration to be used by other schema. Indicates the user's eBay PowerSeller tier. (out) Bronze (out) Silver (out) Gold (out) Platinum (out) Titanium (out) None (out) Reserved for internal or future use SellerPaymentMethodCodeType - Type declaration to be used by other schema. These are payment methods that sellers can use to pay eBay fees. Used for all other payment methods (e.g., payment via PayPal) which are not specifically listed in other columns. Credit Card Direct Debit Direct Debit, pending signature mandate eBay Direct Pay (out) Reserved for internal or future use Defines the values that make up the seller's preferences. Indicates whether the seller wants all transactions with eBay to use the address specified in SellerPaymentAddress. GetUserPreferences Conditionally SetUserPreferences No Determines whether the Pay Now button should always be displayed for the user's listings. GetUserPreferences Conditionally SetUserPreferences No Specifies whether a seller wants to let buyers know that PayPal payments are preferred. GetUserPreferences Conditionally SetUserPreferences No Specifies the default email address the seller uses for receiving PayPal payments. GetUserPreferences Conditionally SetUserPreferences No Indicates whether PayPal is always accepted for the seller's listings. GetUserPreferences Conditionally SetUserPreferences No Specifies the address the seller uses to receive payments from buyers. GetUserPreferences Conditionally SetUserPreferences No Specifies the type of United Postal Service rates to use. GetUserPreferences Conditionally SetUserPreferences No A payment between Half.com and a seller. The financial value of a payment is typically based on an amount that a buyer paid to Half.com for a transaction, plus the shipping cost the buyer paid for the item, minus Half.com's commission. Each payment is for one transaction for one item in one order. ID of the Half.com item associated with the payment. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetSellerPayments Always ID of the Half.com transaction associated with the payment. 10 GetSellerPayments Always ID of the Half.com order associated with the payment. Returns 0 for single-transaction orders. GetSellerPayments Always An ID that the seller specified when they listed the Half.com item, if any. It can be used for the seller's SKU. Note that SellerInventoryID is not returned if no ID was specified. (Note: The SKU field used for eBay.com listings is not applicable to Half.com listings.) GetSellerPayments Conditionally A text note that the seller specified for the Half.com item, if any. Only visible to the seller. Not returned if the seller specified no notes. GetSellerPayments Conditionally Contains an ISBN, UPC, or EAN value from the catalog product associated with the Half.com item. All Half.com items are listed with Pre-filled Item Information. GetSellerPayments Always The title of the listing, as it appears on Half.com. GetSellerPayments Always Indicates whether the payment is for a Half.com sale or a refund. GetSellerPayments Always Price of the transaction specified by TransactionID (before shipping and other costs). GetSellerPayments Always The adjusted shipping cost that Half.com pays the seller. If multiple items from the same seller are in the same order, this amount may be less than the rate for shipping the item individually. This amount may also be adjusted due to Half.com handling charges. (Due to the way shipping costs are calculated, this value may be different for identical items in different orders.) GetSellerPayments Always Amount of commission charged by Half.com. GetSellerPayments Always Payment amount made by buyer for the Half.com transaction. GetSellerPayments Always The time and date when Half.com created the payment. This time is specified in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and other time zones A payment is created when the buyer pays for an order. GetSellerPayments Always Information about a user returned in the context of an item's seller. Indicates the seller's PaisaPay registration status. 0 - Seller not registered 1 - Seller registered 2 - Seller registered but registration suspended 3 - Seller registered but outbound payment suspended GetBidderList GetItem Conditionally GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Indicates whether the user as a seller by default allows buyers to edit the total cost of an item (while in checkout). (Sellers enable this property in their My eBay user preferences on the eBay site.) GetAllBidders GetBidderList Always GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Always SellerInfo none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Currency type in which the user is billed seller fees. GetItem Conditionally Indicates whether the user as a seller has the option set to default new item listings to go through checkout. (Sellers enable this property in their My eBay user preferences on the eBay site.) GetAllBidders GetBidderList Always GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always GetSellerList Always SellerInfo none, ItemReturnDescription, ReturnAll If true, indicates that the user has stored bank account information with eBay in order to use the "CIP in checkout" feature. Applicable to all eBay sites that support CIP as a payment method. GetAllBidders GetBidderList Always GetUser Conditionally GetSellerList Always SellerInfo none, ItemReturnDescription, ReturnAll GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always If true, indicates that the user is in good standing with eBay. (One of the requirements for listing a new item with Immediate Payment.) GetAllBidders GetBidderList Always GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Always SellerInfo none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always If true, the user is authorized to list lot items to the eBay Live Auctions site. GetAllBidders GetBidderList Always GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Always SellerInfo none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Indicates whether the seller participates in the Merchandising Manager feature. If so, the seller can set up rules for cross-promoting items from the seller's store. If not, eBay cross-promotes items as the seller's items are being viewed or purchased. GetAllBidders GetBidderList Always GetSellerList Always SellerInfo none, ItemReturnDescription, ReturnAll GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Indicates whether the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. GetAllBidders GetBidderList Always GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Always SellerInfo none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Maximum level of Motor's Seller guarantee the seller is authorized to offer. GetBidderList GetItem GetUser Conditionally GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally The user's eBay PowerSeller tier. Possible values are enumerated in the SellerLevelCodeType code list. GetAllBidders GetBidderList Always GetSellerList Always SellerInfo none, ItemReturnDescription, ReturnAll GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Address used by eBay for purposes of billing the user for seller fees. GetUser Conditionally ReturnAll Container for scheduling limits for the user. Conveys the minimum and maximum minutes the user may schedule listings in advance, as well as the maximum number of items the user may schedule. GetItem GetUser Conditionally Indicates whether the user has an eBay Store (boolean value). GetAllBidders GetBidderList Always GetSellerList Conditionally SellerInfo none, ItemReturnDescription, ReturnAll GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always URL for the user's eBay Store, if the user is a Store owner. Blank if not. GetAllBidders Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always GetSellerList Conditionally SellerInfo none, ItemReturnDescription, ReturnAll Type of seller account. This value can be returned if the German site (site ID 77) or eBay Motors site (site ID 100) is specified. GetBidderList GetItem Conditionally If true, the user is registered as a vehicle dealer on the eBay Motors site. GetUser Conditionally If true, the user is eligible to sell items on eBay Express, based on the data available to eBay at the time you execute the call (e.g., GetUser). For users registered in the US or Canada, the user is eligible to sell on Express US. For users registed in Germany, the user is eligible to sell on Express Germany. However, a user can still be disqualified at any time if their feedback score changes or some other event occurs that would normally disqualify a seller for Express. If false, the user is not eligible to sell items on Express. In this case, you may be able to determine probable causes by examining these fields: - User.FeedbackPrivate - User.FeedbackScore - User.PositiveFeedbackPercent - User.RegistrationAddress.CountryName - User.Site - CombinedPaymentPreferences (in GetUserPreferences) Seller Eligibility Criteria for eBay Express http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressSellerCriteria GetSellerList Always Seller ItemReturnDescription, ReturnAll GetUser Always GetItemTransactions GetSellerTransactions Always none, ReturnAll GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Details about the store and checkout preferences. GetUser Conditionally If true, the seller has an Express wallet, which is used to store information about multiple credit cards associated with the seller's account. GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Always none, ReturnAll GetUser Always none, ReturnAll GetSellerList Always Seller ItemReturnDescription, ReturnAll Returned if the user is a Selling Manager Pro user. The exact product name of an item. GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none The numeric part number of an item. GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none The alphanumeric part number of an item. GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none Contains various details about the current status of a listing. These values are computed by eBay and cannot be specified at listing time. Number of bids placed so far against the item. Only applicable to competitive-bidding listings (Chinese and Dutch auctions). GetCategoryListings GetMyeBay GetSearchResults Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetMyeBayBuying BidList LostList WonList Conditionally none, ReturnSummary, ReturnAll GetMyeBaySelling Conditionally UnsoldList GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerEvents Conditionally none, ReturnAll Smallest amount a bid must be above the current high bid. Only applicable to competitive-bidding listings (Chinese and Dutch auctions). Returns zero (0.00) for Ad type, eBay Stores Inventory (Stores Fixed-price), and Basic Fixed-Price (Fixed Price Item) listings. GetSellerList Conditionally ItemReturnDescription, ReturnAll GetMyeBay Conditionally GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. GetBidderList GetDispute PlaceOffer Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always GetOrderTransactions Conditionally none GetCategoryListings GetMyeBay GetSearchResults Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetMyeBayBuying WonList Conditionally none, ReturnSummary, ReturnAll For competitive-bidding listings (Chinese and Dutch auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised. For GetSearchResultsExpress, this is the current fixed price of the listing, and it is always returned when ItemArray.Item is returned. GetBidderList GetDispute GetMyeBay PlaceOffer Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Always GetOrderTransactions Conditionally none GetSellerList Conditionally ItemReturnDescription, ReturnAll GetCategoryListings GetMemberMessages GetSearchResults Conditionally GetMyeBayBuying BestOfferList BidList LostList WatchList WonList Conditionally none, ReturnSummary, ReturnAll GetMyeBaySelling Conditionally ActiveList SoldList UnsoldList GetSellerEvents Conditionally none, ReturnAll GetSearchResultsExpress Conditionally For auctions that have ended and have a winning bidder, indicates the user who is the current high bidder. For Basic Fixed Price (FixedPriceItem) and Store Inventory (StoresFixedPrice) listings that have ended, indicates the user who purchased the item. Not returned for auctions that have received no bids or Fixed Price Item and Stores Fixed-price listings that are still active. PlaceOffer Always GetSellerList Conditionally ItemReturnDescription, ReturnAll GetMyeBay Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetMyeBayBuying BidList Conditionally none, ReturnSummary, ReturnAll GetMyeBaySelling Conditionally ActiveList GetSellerEvents Conditionally ReturnAll Applicable to Ad type listings only. Indicates how many leads to potential buyers are associated with this item. Returns 0 (zero) for listings in other formats. GetSellerList Conditionally ReturnAll GetBidderList GetMyeBay Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Smallest amount the next bid on the item can be. Returns same value as Item.StartPrice (if no bids have yet been placed) or CurrentPrice plus BidIncrement (if at least one bid has been placed). Only applicable to Chinese and Dutch auction listings. Returns null for basic Fixed Price (FixedPriceItem), Store Inventory (StoresFixedPrice), and Ad type listings. GetMyeBay PlaceOffer Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Number of items purchased so far. (Subtract from the value returned in the Item.Quantity field to calculate the number of items remaining.) GetMyeBay Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions ReturnAll Always GetOrderTransactions Conditionally none GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerEvents Conditionally none, ReturnAll Indicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified. PlaceOffer Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetMyeBayBuying BidList Conditionally none, ReturnSummary, ReturnAll GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetMyeBaySelling Conditionally ActiveList Part of the Second Chance Offer feature, indicates whether the seller can extend a second chance offer for the item. GetMyeBay Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Number of bidders for an item. Only applicable to competitive-bidding listings (Chinese and Dutch auctions). Only returned for the seller of the item. GetMyeBaySelling Conditionally ActiveList UnsoldList Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing. GetAllBidders GetBidderList GetHighBidders Always GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Always GetOrderTransactions Conditionally none GetSellerList Conditionally ItemReturnDescription, ReturnAll GetSellerEvents Conditionally none, ReturnAll You are charged a Final Value Fee if your item is sold, ends with a winning bid, or is purchased. This fee applies whether or not you actually complete the sale with the buyer. See the eBay.com Web site online help for more information about the Final Value Fee. If the item was a Dutch auction that ended with bids (not Buy It Now purchases), the Final Value Fee is returned in Item.SellingStatus.FinalValueFee. For all other listing types, including Dutch auctions that end with Buy It Now purchases, the Final Value Fee is returned in Transaction.FinalValueFee. The Final Value Fee for fixed price format (FixedPriceItem), Store Inventory format (StoresFixedPrice), and Dutch listings purchased with Buy It Now is returned by GetSellerTransactions and GetItemTransactions on a transaction by transaction basis, regardless of the listing status. For all other listing types, including Chinese and Dutch (with no Buy It Now purchases), the Final Value Fee is returned when the listing status is Completed. If you request a Final Value Fee Credit, the value of Transaction.FinalValueFee will not change for the item if a credit is issued. (The credit only appears in the seller's account data.) GetBidderList GetItem Conditionally GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none The number of listings the user has open. GetMyeBaySelling Always The total number of items the user is currently selling. GetMyeBaySelling Always The total number of bids made on the user's active listings. GetMyeBaySelling Always The total value of all items the user has for sale in all listings. GetMyeBaySelling Always The total number of items the user has sold. GetMyeBaySelling Always The total monetary value of the items the user has sold. GetMyeBaySelling Always The average duration, in days, of all items sold. GetMyeBaySelling Always Status of the delivery. Created (default). Dropped off. In transit. Delivered. Returned. Cancelled. Label printed. Reserved for future use. Depth dimension of the package needed to ship the item after it is sold. For calculated shipping only. Length dimension of the package needed to ship the item after it is sold. For calculated shipping only. Width dimension of the package needed to ship the item after it is sold. For calculated shipping only. The address from which the item is being shipped. The address to which the item is to be shipped. The shipping carrier used. The size of the package used to ship the item(s). See ShippingPackageCodeType for its possible values. Input. The size of the package used to ship the item(s). See ShippingPackageCodeType for its possible values. Input. See the documentation regarding "Working with Item Weights". The 'unit' attribute can have a value of lbs. See the documentation regarding "Working with Item Weights". The 'unit' attribute is optional and assumed to be the minor compared to the value of 'unit' in WeightMajor. Revise only Revise only Revise only Revise only TODO probably not needed, why two statuses? - revise only Identifies a shipping carrier. (in/out) United Parcel Service. (in/out) U.S. Postal Service. Deutsche Post. DHL service Hermes. iLoxx. Other Postal Service. (out) Reserved for internal or future use. Type for the shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. Instead of using this tag, see the PaymentEdited tag. Originally, the AllowPaymentEdit tag specified whether the seller allows the buyer to edit the payment amount for the transaction. (Sellers enabled this property in their My eBay user preferences on the eBay site.) ShippingDetails.AllowPaymentEdit is no longer being populated by calls to GetItemTransactions. Not applicable to Half.com. GetBidderList Conditionally Deprecated GetSellerList Conditionally ItemReturnDescription, ReturnAll Deprecated GetOrderTransactions Conditionally Deprecated none GetItem Conditionally Deprecated none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Whether the seller specifies that a shipping discount is to be applied (in the event that an item's transaction is later combined with others into a single order). Not applicable to Half.com. GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none AddOrder No Details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension and weight and packaging/handling costs. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none GetItemShipping Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll Whether the seller specified payment and shipping instructions during checkout (for example, to update the details of a transaction). Flat and calculated shipping. Not applicable to Half.com. GetItemShipping Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none 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. 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. Also applicable to Half.com (for GetOrders). 0.00 AddItem GetItemRecommendations AddOrder RelistItem ReviseItem VerifyAddItem No GetBidderList GetItemShipping Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrders Always Order Transaction GetOrderTransactions Always Order Transaction none Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true. Also applicable to Half.com (for GetOrders). AddItem GetItemRecommendations AddOrder RelistItem ReviseItem VerifyAddItem No GetBidderList GetItemShipping Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrders Always Transaction Order GetOrderTransactions Always Transaction Order none Whether the buyer selected to pay for insurance offered by the seller as an option. This only has a value after the buyer has gone through checkout and selected the insurance preference. Also applicable to Half.com (for GetOrders). GetOrders Always Order Transaction GetOrderTransactions Always none Order Transaction GetItemShipping Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll Whether the seller allows the buyer to edit the payment amount for the transaction. (Sellers enable this property in their My eBay user preferences on the eBay site.) Not applicable to Half.com. GetItemShipping Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll Payment instructions/message from the seller to the buyer. Flat and calculated shipping and return policy instructions. (Some sites also let you specify a standard return policy by using site-wide attributes in addition or instead. See Item.AttributeSet.) See the eBay Web Services Guide for information about specifying shipping instructions and return policies. Characters like & and ' (apostrophe/single quote) count as 5 characters each. To remove this value when revising or relisting an item, use DeletedField. Not applicable to Half.com. 500 (250 for China and Taiwan) AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem GetItemShipping Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll Sales tax details. US site only. Flat and calculated shipping. Also applicable to Half.com (for GetOrders). If your application normally calculates sales tax without using eBay's tax tables, you should understand how purchases via eBay Express will affect the way you process payments. For general information about listings on eBay Express, see "eBay Express" in the eBay Web Services Guide. AddItem AddOrder GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItemShipping Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrders Always Order Transaction GetOrderTransactions Always none Order Transaction Deprecated. Will be removed in a future release. Postal code from seller's registration address. Not for calculating shipping costs--see CalculatedShippingRateType.OriginatingPostalCode. Not applicable to Half.com. GetSellerList Conditionally ItemReturnDescription, ReturnAll Deprecated GetBidderList Conditionally Deprecated GetItem Conditionally Deprecated none, ItemReturnDescription, ItemReturnAttributes, ReturnAll For most applicable calls, returns the words No Error or returns an error message related to an attempt to calculate shipping rates. For calculated shipping only. Not applicable to Half.com. GetSearchResultsExpress returns this when no PostalCode was specified in the request and the item was listed with calculated shipping rates. The message text explains that a postal code is needed to calculate shipping. Only returned when ItemDetails is set to Fine. GetItemShipping Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll GetSearchResultsExpress Conditionally A shipping rate scale for shipping through UPS that affects the shipping cost calculated for UPS (lower if ShippingRateType is DailyPickup). ShippingRateType is only returned if ShippingService is one of the UPS shipping services. For calculated shipping only. Not applicable to Half.com. GetBidderList GetItem GetItemShipping Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll Shipping http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Shipping Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. Not applicable to Half.com. GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetMyeBayBuying Conditionally BidList GetMyeBaySelling Conditionally ScheduledList GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemShipping Conditionally GetItemTransactions Conditionally none, ReturnAll GetOrders Conditionally Order Transaction GetOrderTransactions Conditionally none Order Transaction AddOrder No Overview of the XML API Schema http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SchemaOverview rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1) Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions. If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes. If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. Not applicable to Half.com. AddItem AddOrder GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem GetItemShipping Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemTransactions Conditionally none, ReturnAll GetOrders Conditionally Order Transaction GetOrderTransactions Conditionally none Order Transaction Overview of the XML API Schema http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SchemaOverview rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1) The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is Flat or Freight. Not applicable to Half.com. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetSearchResults Conditionally Applicable to Selling Manager Pro sellers. Also applicable to Half.com (for GetOrders). For GetOrders, the Transaction container includes this element within ShippingDetails. GetBidderList GetItem Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrders Conditionally Order Transaction GetOrderTransactions Conditionally Order Transaction none Whether checkout for this is to be handled by a Third-Party Checkout application. The counterpart in the Add family of calls is Item.ThirdPartyCheckout. Not applicable to Half.com. AddOrder No GetItem Always GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItemShipping Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll Third Party Checkout http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ThirdPartyCheckout Tax details for a jurisdiction such as a state or province. Returns empty in GetItem if no tax table was used. Not applicable to Half.com. GetItem Always none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetBidderList GetItemShipping Conditionally GetOrderTransactions Conditionally none, ReturnAll GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day. Also applicable to Half.com (for GetOrders). GetBidderList GetItem GetItemShipping Conditionally GetItemTransactions GetSellerTransactions Conditionally none, ReturnAll GetOrders Always Transaction Order GetOrderTransactions Always none Order Transaction Shipment tracking number supplied by the shipping carrier. Not applicable to Half.com. GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll The shipping service that actually shipped the item(s). Not applicable to Half.com. GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll The default shipping cost for the item. For GetSearchResults: If ShippingType has the value Flat, then the actual shipping cost is shown. If ShippingType has the value Free, then zero is shown. If ShippingType has the value Calculated, then this tag (DefaultShippingCost) is not shown. If ShippingType has the value NotSpecified, then this tag (DefaultShippingCost) is not shown. If ShippingType has the value Freight, then this tag (DefaultShippingCost) is not shown. In GetSearchResultsExpress: If flat or free shipping was specified for the item, then the actual shipping cost is shown. If calculated shipping was specified for the item, then this tag (DefaultShippingCost) is only shown if PostalCode is specified in the GetSearchResultsExpress request. Otherwise, ShippingRateErrorMessage is returned with a message that the postal code is required for the shipping calculation. Only returned when ItemDetails is set to Fine. Not applicable to Half.com. GetSearchResultsExpress GetSearchResults Conditionally Miscellaneous details of the shipment. Confirmation requested. Signature requested upon receipt. Stealth postage. Saturday delivery. Other. Not defined. (out) Reserved for internal or future use. Details about a region or location to which the seller is willing to ship. Short name or abbreviation for a region (e.g., Asia) or location (e.g. Japan). Related field: Item.ShippingDetails.InternationalShippingServiceOption.ShipToLocation in AddItem GeteBayDetails Conditionally Display name of region or location (sometimes more descriptive than the ShippingLocation short name). GeteBayDetails Conditionally Where the seller is willing to ship the item. (in/out) Seller will only ship to a buyer in the same country/region as the eBay site the item is listed on. (in/out) Seller will ship to a buyer anywhere in the world. (in/out) Seller will ship to a buyer on the same eBay site or in one of the specified regions (ShippingRegionCodeType). (in/out) Seller will not (or cannot) ship the item to any buyer at any location. (out) Reserved for internal or future use. (in/out) The nature of the package used to ship the item(s). Required for calculated shipping only. Not all package types are supported by a specific shipping service (ShippingServiceCodeType). (in/out) None (in/out) Letter (in/out) LargeEnvelope (in/out) USPS Large Package/Oversize 1 (in/out) Very Large Package/Oversize 2 (in/out) Extra Large Package/Oversize 3 (in/out) UPS Letter (in/out) USPS Flat Rate Envelope (in/out) Package/thick envelope (in/out) Roll (in/out) Europallet (in/out) Onewaypallet (in/out) Bulky goods (in/out) Furniture (in/out) Cars (in/out) Motorbikes (in/out) Caravan (in/out) Industry vehicles (out) Reserved for internal or future use. A shipping rate scale for shipping through UPS that affects the shipping cost calculated for UPS (lower if ShippingRateType is DailyPickup). For calculated shipping only. "On-demand" shipping rate scale. "Daily pickup" shipping rate scale. (out) Reserved for internal or future use. Regions to which the seller is willing to ship the item. Only applicable if the seller specifies SitePlusRegions for the shipping option (ShippingOptionCodeType). (in/out) Africa (in/out) Asia (in/out) Caribbean (in/out) Europe (in/out) Latin America (in/out) Middle East (in/out) NorthA merica (in/out) Oceania (Pacific region other than Asia) (in/out) South America (in/out) European Union (in/out) Seller will not ship the item. (in/out) Seller has specified Worldwide or eBay has determined that the specified regions add up to Worldwide. (in/out) (in/out) (out) Reserved for internal or future use A shipping service used to ship an item. Applications should not depend on the completeness of ShippingServiceCodeType. GeteBayDetails will return the complete list of shipping services. To check whether a shipping service is domestic or international, call GeteBayDetails with a DetailName of ShippingServiceDetails, specifying a site in the header. Shipping services with a ShippingServiceID of 50000 or higher are international, and the other services are domestic, for that site. (in/out) UPS Ground. (in/out) UPS 3rd Day. (in/out) UPS 2nd Day. (in/out) UPS Next Day. (in/out) USPS Priority. (in/out) USPS Parcel. (in/out) USPS Media. (in/out) USPS First Class. (in/out) Standard shipping method. (in/out) Reserved for internal or future use. (in/out) USPS Express Mail. (in/out) UPS Next Day Air. (in/out) UPS Next Day Air. (in/out) Other (see description). (in/out) Local Delivery/Pickup. (in/out) Not Selected. (in/out) International Not Selected. (in/out) Standard International Flat Rate Shipping. (in/out) Expedited International Flat Rate Shipping. (in/out) USPS Global Express Mail. (in/out) USPS Global Priority Mail. (in/out) USPS Economy Parcel Post. (in/out) USPS Economy Letter Post. (in/out) USPS Airmail Letter Post. (in/out) USPS Airmail Parcel Post. (in/out) UPS Worldwide Express Plus. (in/out) UPS Worldwide Express. (in/out) UPS Worldwide Expedited. (in/out) UPS Standard To Canada. (in/out) Other International Shipping (see description). (in/out) Standardversand (unversichert). (in/out) Versicherter Versand. (in/out) Express- oder Kurierversand. (in/out) Versicherter Express- oder Kurierversand. (in/out) Sonstige (Siehe Artikelbeschreibung). (in/out) Unversicherter Versand International. (in/out) Versicherter Versand International. (in/out) Sonstiger Versand International. (in/out) Unversicherter Express Versand International. (in/out) Versicherter Express Versand International (in/out) Regular. (in/out) Express. (in/out) Registered. (in/out) Courier. (in/out) Other. (in/out) EMS International Courier - Parcels. (in/out) EMS International Courier - Documents. (in/out) Express Post International - Documents. (in/out) Air Mail. (in/out) Economy Air. (in/out) Sea Mail. (in/out) Standard International Flat Rate Postage. (in/out) Expedited International Flat Rate Postage. (in/out) Other International Postage (see description). (in/out) (in/out) (in/out) (in/out) (in/out) (in/out) De Post. (in/out) UPS. (in/out) Fedex. (in/out) DHL. (in/out) TPG Post/TNT (Netherlands). (in/out) Frais de livraison internationale fixes. (in/out) Frais fixes pour livraison internationale express. (in/out) Autres livraisons internationales (voir description). (in/out) La Poste (France). (in/out) Standard Delivery. (in/out) Priority Delivery (in/out) Parcel Post (in/out) Registered Mail (in/out) Other Shipping Service. (in/out) De Post. (in/out) UPS. (in/out) Fedex. (in/out) DHL. (in/out) TPG Post/TNT (Netherlands). (in/out) Standard International. (in/out) Expedited International. (in/out) Other International Shipping Services. (in/out) La Poste (France). (in/out) Standard Delivery. (in/out) Canada Post Lettermail. (in/out) Canada Post Regular Parcel. (in/out) Canada Post Expedited Parcel. (in/out) (in/out) Canada Post Priority Courier. (in/out) Standard International Flat Rate Shipping. (in/out) Expedited International Flat Rate Shipping. (in/out) Other International Shipping (see description). (in/out) (in/out) (in/out) (in/out) (in/out) (in/out) (in/out) Small Packets - International. (in/out) Purolator International. (in/out) Canada Post Small Packets - USA - Ground. (in/out) Canada Post Small Packets - USA - Air. (in/out) Small Packets - International - Ground. (in/out) Small Packets - International - Air. (in/out) Canada Post USA Letter-post. (in/out) Canada Post International Letter-post. (in/out) UPS Express Canada. (in/out) UPS Express Saver Canada. (in/out) UPS Expedited Canada. (in/out) UPS Standard Canada. (in/out) UPS Express United States. (in/out) UPS Expedited United States. (in/out) UPS 3 Day Select United States. (in/out) UPS Standard United States. (in/out) UPS Worldwide Express. (in/out) UPS Worldwide Expedited. (in/out) Standardversand (A-Post/Priority). (in/out) Standardversand (B-Post/Economy). (in/out) Versicherter Versand (z.B. Assurance/Fragile). (in/out) Express- oder Kurierversand. (in/out) Versicherter Express- oder Kurierversand. (in/out) Sonstige (Siehe Artikelbeschreibung). (in/out) Sonstiger Versand (Siehe Artikelbeschreibung). (in/out) ECONOMY Sendungen. (in/out) PRIORITY Sendungen. (in/out) URGENT Sendungen. (in/out) (in/out) (in/out) (in/out) (in/out) (in/out) Unversicherter Versand. (in/out) Versicherter Versand. (in/out) Express- oder Kurierversand. (in/out) Versicherter Express- oder Kurierversand. (in/out) Unversicherter Versand. (in/out) Deutsche Post Brief. (in/out) DHL Postpaket. (in/out) Deutsche Post Warensendung. (in/out) Hermes Paket (unversichert). (in/out) Hermes Paket (versichert). (in/out) iloxx Transport XXL. (in/out) iloxx Standard. (in/out) Sonstige (Siehe Artikelbeschreibung). (in/out) Unversicherter Versand. (in/out) Versicherter Versand. (in/out) DHL Postpaket International. (in/out) Sonstiger Versand (Siehe Artikelbeschreibung). (in/out) Unversicherter Express - Versand. (in/out) Versicherter Express - Versand. (in/out) Deutsche Post Brief (Land). (in/out) Deutsche Post Brief (Luft). (in/out) iloxx Europa. (in/out) iloxx World Wide. (in/out) Cartas nacionales hasta 20 gr. (in/out) Cartas internacionales hasta 20 gr. (in/out) Cartas internacionales de mas de 20 gr. (in/out) Paquete Azul (nacional) hasta 2 kg. (in/out) Cartas y tarjetas postales internacionales. (in/out) Ems postal expres internacional. (in/out) Paquete internacional economico. (in/out) Chronoposte International Classic. (in/out) Coliposte Colissimo Direct. (in/out) DHL Express Europack. (in/out) UPS Standard. (in/out) Lettre. (in/out) Lettre avec suivi. (in/out) Colissimo. (in/out) Contre remboursement. (in/out) Autre mode d'envoi de courrier. (in/out) Ecopli. (in/out) Autre mode d'envoi de colis. (in/out) Remise en main propre. (in/out) La Poste - Courrier International Prioritaire. (in/out) La Poste - Courrier International Economique. (in/out) La Poste - Colis Postal Prioritaire. (in/out) La Poste - Colis Postal Economique. (in/out) Emballage Colissimo International. (in/out) Chronopost Classic International. (in/out) Chronopost Premium International. (in/out) UPS Standard. (in/out) UPS Express. (in/out) DHL. (in/out) National - Regular (in/out) National - Express (in/out) National - COD (in/out) Local - Courier (in/out) Local - COD (in/out) International - Standard (in/out) International - Expedited (in/out) International - other (in/out) Flat Rate COD (in/out) Buyer picks up and pays (in/out) Posta ordinaria. (in/out) Posta prioritaria. (in/out) Posta raccomandata. (in/out) Posta raccomandata con contrassegno. (in/out) Posta assicurata. (in/out) Posta celere. (in/out) Pacco ordinario. (in/out) Pacco celere 1. (in/out) Pacco celere 3. (in/out) Corriere espresso. (in/out) Spedizione internazionale standard a prezzo fisso. (in/out) Spedizione internazionale celere a prezzo fisso. (in/out) Altre spedizioni internazionali (vedi descrizione). (in/out) Standaardverzending. (in/out) Pakketpost. (in/out) Verzending met ontvangstbevestiging. (in/out) Andere verzendservice. (in/out) TPG Post/TNT. (in/out) UPS. (in/out) Fedex. (in/out) DHL. (in/out) DPD (Germany). (in/out) GLS (Business only). (in/out) Vaste kosten standaard internationale verzending. (in/out) Vaste kosten versnelde internationale verzending. (in/out) Andere internationale verzending (zie beschrijving). (in/out) Fedex International Priority. (in/out) Fedex International Economy. (in/out) UPS Worldwide Expedited. (in/out) UPS Worldwide Express. (in/out) UPS Worldwide Express Plus. (in/out) Royal Mail 1st Class Standard. (in/out) Royal Mail 2nd Class Standard. (in/out) Royal Mail 1st Class Recorded. (in/out) Royal Mail 2nd Class Recorded. (in/out) Royal Mail Special Delivery. (in/out) Royal Mail Standard Parcels. (in/out) Parcelforce 24. (in/out) Parcelforce 48. (in/out) Other Courier. (in/out) Seller's Standard Rate. (in/out) Collection in Person. (in/out) Sellers Standard International Rate. (in/out) Royal Mail Airmail. (in/out) Royal Mail Airsure. (in/out) Royal Mail Surface Mail. (in/out) Royal Mail International Signed-for. (in/out) Royal Mail HM Forces Mail. (in/out) Parcelforce International Datapost. (in/out) Parcelforce Ireland 24. (in/out) Parcelforce Euro 48. (in/out) Parcelforce International Scheduled. (in/out) Other courier or delivery service. (in/out) Collect in person. (in/out) Seller's standard rate. (in/out) First Class Letter Service. (in/out) SwiftPost National. (in/out) Registered Post. (in/out) EMS SDS Courier. (in/out) Economy SDS Courier. (in/out) Other courier. (in/out) Collection in person. (in/out) Seller's Standard International Rate. (in/out) International Economy Service. (in/out) International Priority Service. (in/out) SwiftPost Express. (in/out) SwiftPost International. (in/out) EMS SDS Courier. (in/out) Economy SDS Courier. (in/out) Other courier or delivery service. (in/out) International collection in person. (in/out) Domestic Regular shipping. (in/out) Domestic Special shipping. (in/out) Freight Shipping. (in/out) Freight Shipping International (in/out) Overnight flat rate shipping service. Domestic only. (out) Reserved for internal or future use. (in/out) USPS Priority.Flat Rate Envelope (in/out) USPS Priority.Flat Rate Box (in/out) USPS Global Priority Mail Small Envelope (in/out) USPS Global Priority Mail Large Envelope (in/out) USPS Express Mail.Flat Rate Envelope (in/out) UPS Worldwide Express Box 10 Kg. (in/out) UPS Worldwide Express Box 25 Kg. (in/out) UPS Worldwide Express Plus Box 10 Kg. (in/out) UPS Worldwide Express Plus box 25 Kg.. (in/out) Local pick up only. (in/out) Local courier. (in/out) Domestic regular shipping. (in/out) Domestic special shipping. (in/out) International regular shipping. (in/out) International special shipping. (in/out) Local pick up only. (in/out) Local courier. (in/out) Domestic standard mail. (in/out) Domestic non standard mail. (in/out) Domestic Speedpost Islandwide. (in/out) International standard mail. (in/out) International Express Mail Service (EMS). (in/out) International courier (DHL, FedEx, UPS). Details about a specific shipping service. Full name of the shipping service for display purposes. GeteBayDetails Conditionally Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Whether the service is an expedited shipping service. Only returned for sites for which the Get It Fast feature is enabled and only if true. Related fields: Item.DispatchTimeMax and Item.GetItFast in AddItem GeteBayDetails Conditionally Whether the shipping service is an international shipping service, i.e. one that ships from to another country from the country of the specified site. Related field: Item.ShippingDetails.InternationalShippingServiceOption in AddItem GeteBayDetails Conditionally Value used for the shipping service. For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. Related fields: Item.ShippingDetails.InternationalShippingServiceOption.ShippingService in AddItem Item.ShippingDetails.ShippingServiceOptions.ShippingService in AddItem GeteBayDetails Conditionally Numeric identifier. A value greater than 50000 represents an international shipping service (confirmed by InternationalShippingService being true). Some applications use this ID to look up shipping services more efficiently. Also useful for applications that have migrated from the legacy XML API. GeteBayDetails Conditionally The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). Always returned when ExpeditedService is true or if defined for a particular service. See Enabling Get It Fast feature. GeteBayDetails Conditionally The minimum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). Always returned when ExpeditedService is true or if defined for a particular service. See Enabling Get It Fast feature. GeteBayDetails Conditionally For future use. Shipping costs and options related to a domestic shipping service. 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. Also applicable to Half.com (for GetOrders). GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItem GetItemShipping GetOrders Conditionally GetOrderTransactions Conditionally none AddOrder SendInvoice No GetItemTransactions Conditionally none, ReturnAll Getting Shipping Cost Information http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts A domestic shipping service offered for shipping the item (for example, UPS Ground). For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). SendInvoice No AddItem AddOrder GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemShipping GetOrders Conditionally GetOrderTransactions Conditionally none GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions Conditionally none, ReturnAll 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. Also applicable to Half.com (for GetOrders). SendInvoice No AddItem AddOrder GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItemShipping GetOrders Conditionally GetOrderTransactions Conditionally none GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions Conditionally none, ReturnAll GetMyeBayBuying Conditionally BidList GetMyeBaySelling Conditionally ScheduledList Getting Shipping Cost Information http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items and should be zero for single-item listings. Default value is 0.00. For flat shipping only. Not applicable to Half.com. SendInvoice No AddItem AddOrder GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItemShipping GetOrders Conditionally GetOrderTransactions Conditionally none GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions Conditionally none, ReturnAll Getting Shipping Cost Information http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts Seller-preferred presentation order relative to other service options. Valid values: 1 (1st choice), 2 (2nd choice), 3 (3rd choice). For flat and calculated shipping. Not applicable to Half.com. SendInvoice No AddItem AddOrder GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItemShipping GetOrders Conditionally GetOrderTransactions Conditionally none GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions Conditionally none, ReturnAll Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Not applicable to Half.com. GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemShipping GetOrders Conditionally GetOrderTransactions Conditionally none GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions Conditionally none, ReturnAll The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com. GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemShipping Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions Conditionally none, ReturnAll The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com. GetSellerList Conditionally ItemReturnDescription, ReturnAll GetItemShipping Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions Conditionally none, ReturnAll If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Shipping terms codes indicate who pays for the shipping of an item, the seller or the buyer. (in/out) Seller pays all shipping costs. (in/out) Buyer pays all shipping costs. (out) Reserved for internal or future use. The shipping cost model offered by the seller. (in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. (in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts. (out) Freight shipping model: the cost of shipping is determined by a third party, FreightQuote.com, based on the item location (zip code). Currently, Freight can only be specified on input via eBay Web site, not API. (in/out) Free shipping. (in/out) The seller did not specify the shipping type. (out) Reserved for internal or future use. SiteCodeType - Type declaration to be used by other schema. Identifies eBay sites (by the country in which each resides) on which a user is registered and on which items can be listed. (in/out) USA, site ID 0, abbreviation US, currency USD. (in/out) Canada, site ID 2, abbreviation CA, currencies CAD and USD. (in/out) United Kingdom, site ID 3, abbreviation UK, currency GBP. (in/out) Australia, site ID 15, abbreviation AU, currency AUD. (in/out) Austria, site ID 16, abbreviation AT, currency EUR. (in/out) Belgium (French), site ID 23, abbreviation BEFR, currency EUR. (in/out) France, site ID 71, abbreviation FR, currency EUR. (in/out) Germany, site ID 77, abbreviation DE, currency EUR. (in/out) Italy, site ID 101, abbreviation IT, currency EUR. (in/out) Belgium (Dutch), site ID 123, abbreviation BENL, currency EUR. (in/out) Netherlands, site ID 146, abbreviation NL, currency EUR. (in/out) Spain, site ID 186, abbreviation ES, currency EUR. (in/out) Switzerland, site ID 193, abbreviation CH, currency CHF. (in/out) Taiwan, site ID 196, abbreviation TW, currency TWD. (in/out) eBay Motors, site ID 100, currency USD. (in/out) Hong Kong, site ID 201, abbreviation HK, currency HKD. (in/out) Singapore, site ID 216, abbreviation SG, currency SGD. (in/out) India, site ID 203, abbreviation IN, currency INR. (in/out) China, site ID 223, abbreviation CN, currency CNY. (in/out) Ireland, site ID 205, abbreviation IE, currency EUR. (in/out) Malaysia, site ID 207, abbreviation MY, currency MYR. (in/out) Philippines, site ID 211, abbreviation PH, currency PHP. (in/out) Poland, site ID 212, abbreviation PL, currency PLN. (in/out) Sweden, site ID 218, abbreviation SE, currency SEK. (out) Reserved for internal or future use A container node for feature definitions that apply to the entire site. Specifies the ID of a set of default durations for a certain type of listing. The actual duration values are returned within the FeatureDefinitions node. The type of listing is named in the type attribute. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether sellers are required to specify a shipping service and its associated cost when listing items. True means the shipping terms are required unless a specific category overrides this setting. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether categories allow best offers. True means best offers are allowed site-wide, unless a specific category overrides the setting. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether categories allow DutchBIN. True means best offers are allowed site-wide, unless a specific category overrides the setting. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether a bidder must consent to the bid by confirming that he or she read and agrees to the terms in eBay's privacy policy. GetCategoryFeatures ReturnAll Conditionally Indicates whether or not it is possible to enhance a listing by putting it into a rotation for display on a special area of the eBay home page. Support for this feature varies by site. Item or feedback restrictions may apply. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether categories allow the ProPack feature (a feature pack). True means ProPack is allowed site-wide, unless a specific category overrides the setting. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether categories allow the BasicUpgradePack feature (a feature pack). True means it is allowed site-wide, unless a specific category overrides the setting. Australia site (site ID 15, abbreviation AU) only. Effective beginning February 22, 2006. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether categories allow the ValuePack feature (a feature pack). True means it is allowed site-wide, unless a specific category overrides the setting. Effective beginning February 22, 2006. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether categories allow the ProPackPlus feature (a feature pack). True means it is allowed site-wide, unless a specific category overrides the setting. Effective beginning February 22, 2006. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether categories allow the Ad Format feature. True means the feature is allowed site-wide, unless a specific category overrides the setting. GetCategoryFeatures ReturnAll Conditionally eBay enables you to list and sell digital files (such as Adobe PDF files) or information that buyers can access online or have delivered electronically. This flag specifies whether most categories on the site allow digitally delivered items (i.e., the default setting for the site's categories). If true, digitally delivered items are allowed site-wide, but specific categories can override the setting if they don't support it. If false, digitally delivered items are not normally allowed for the site, but some categories may override the setting. If a category supports digital listings, it means that you have the option to list digital items in that category (i.e., Item.DigitalDeliveryDetails can be specified in your listing request). It does not mean the category requires you to list items digitally. If you list in two categories, an item can only specify this option if both categories support digital listings. Digital listings are not eligible for eBay Express. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether categories allow counter offers for best offers. True means counter offers are allowed site-wide, unless a specific category overrides the setting. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether categories allow auto decline for best offers. True means auto decline is allowed site-wide, unless a specific category overrides the setting. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether LocalMarketSpecialitySubscription feature is supported for this category. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether LocalMarketRegularSubscription feature is supported for this category. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether LocalMarketPremiumSubscription feature is supported for this category. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether LocalMarketNonSubscription feature is supported for this category. GetCategoryFeatures ReturnAll Conditionally Specifies whether most categories on the site are eligible for eBay Express. eBay Express is a specialty site where customers can buy new, fixed-price goods in a more conventional e-commerce experience. If true, items on the site are eligible for Express, but specific categories can override the setting if they don't support Express. For example, categories that are not covered by PayPal Buyer Protection (e.g., Live Auctions and Motors vehicles) are excluded from Express. If false, items on the site are not eligible for Express, but some categories may override the setting. If you list in an Express-enabled category, it does not necessarily mean that the item will appear in that category when buyers browse and search Express. It only means that the item can also be included on Express, assuming all other Express eligibility requirements are met. See "eBay Express" in the eBay Web Services guide for information about other eligibility requirements. GetCategoryFeatures ReturnAll Conditionally Specifies whether most categories on the site require a listing to include a picture in order to qualify for eBay Express. If true, items on the site require a picture in order to qualify for Express, but specific categories can override this requirement. For example, on the US site, pictures are normally required for Express listings. However, the Event Tickets category could override this requirement if pictures are not commonly expected for tickets. If false, items on the site do not require a picture, but some categories may override the setting. Only meaningful if ExpressEnabled is true for the category. GetCategoryFeatures ReturnAll Conditionally Specifies whether most categories on the site require a listing to include the Item Condition attribute in order to qualify for eBay Express. If true, items on the site require the Item Condition in order to qualify for Express, but specific categories can override this requirement. For example, on the US site, the Item Condition is normally required for Express listings. However, the Event Tickets category could override this requirement because there is little need to distinguish between new and used tickets. (People rarely sell used tickets after an event unless the ticket is also a collectible item.) If false, items on the site do not require the Item Condition, but some categories may override the setting. Only meaningful if ExpressEnabled is true for the category. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether the Minimum Reserve Price feature is supported for this category. GetCategoryFeatures ReturnAll Conditionally Reserved for future use. GetCategoryFeatures ReturnAll Conditionally Specifies the default site setting for whether the Transaction Confirmation Request feature is supported for this category. GetCategoryFeatures ReturnAll Conditionally Details about a specific site. Short name that identifies an eBay site. Usually, an eBay site is associated with a particular country or region (e.g., US or Belgium_French). Specialty sites (e.g., eBay Express or eBay Stores) use the same site ID as their associated main eBay site. The US eBay Motors site is an exception to this convention. Related fields: Item.Site in AddItem User.Site in GetUser GeteBayDetails Conditionally Numeric identifier for an eBay site. If you are using the SOAP API, you use numeric site IDs in the request URL. If you are using the XML API, you use numeric site IDs in the X-EBAY-API-SITEID header. GeteBayDetails Conditionally Data for images hosted by eBay Picture Services (EPS).With compatibility level 439 and higher, deprecated in the response in favor of Item.PictureDetails. With the future deprecation of SiteHostedPicture as input, Applications should use Item.PictureDetails instead. Note that the Gallery Plus image enhancement does not support SiteHostedPicture. Use Item.PictureDetails with that feature. (in/out) Contains the URL for an image hosted by eBay Picture Services (EPS) or by Picture Manager and associated with an item. If specified, this cannot have an empty/null value. In general, a listing can have a maximum of 12 picture URLs hosted by eBay Picture Services. For the US eBay Motors site (for all vehicle listings), and for the eBay Canada site for motors, the picture pack of a listing can contain up to 24 photos. To specify multiple pictures, send each URL in a separate, adjacent PictureURL element. In most cases, the image at the first URL is also used for the picture at the top of the View Item page on the Web site. For eBay Live Auctions, a listing can have a maximum of 5 picture URLs hosted by eBay Picture Services. For VerifyAddItem, you can use a fake eBay Picture Services URL (http://i2.ebayimg.com/abc/M28/dummy.jpg) to verify that your application is obtaining the correct fees for the quantity of images you pass in. For listing calls (e.g., AddItem): With the future deprecation of SiteHostedPicture as input, applications should use Item.PictureDetails.PictureURL instead. See Item.PictureDetails.PictureURL for information about how to remove pictures from a listing. For retrieval calls (e.g., GetItem): With compatibility 439 and higher, Item.PictureDetails.PictureURL is returned instead. Note that the Gallery Plus image enhancement does not support SiteHostedPicture. Use Item.PictureDetails with that feature. 150 AddItem AddLiveAuctionItem GetItemRecommendations ReviseItem ReviseLiveAuctionItem RelistItem VerifyAddItem Conditionally Deprecated GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally Deprecated GetItem Conditionally Deprecated none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS), and others are not. eBay determines this by parsing the associated PictureURL. Cannot be used in combination with Listing Designer layouts. Specify None or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No Deprecated GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally Deprecated GetItem Conditionally Deprecated none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Indicates whether a picture for the item is included in the Gallery and, if so whether the item is also featured in the Gallery. If the value is Gallery or Featured, eBay checks the available image URLs in the following order to determine which URL to use (if more than one of these URLs is available): whether the item is also featured or Plus in the Gallery. If the value is Gallery or Plus or Featured, eBay checks the available image URLs a) Use the URL in GalleryURL, if it is specified. b) Otherwise, if ProductListingDetails.UseStockPhotoURLAsGallery is true, use the eBay stock photo. c) Otherwise, use the value of the first PictureURL in the array of PictureURL fields, if any. d) Otherwise, if ProductListingDetails.ProductID is specified, use the eBay stock photo (eBay resets UseStockPhotoURLAsGallery to true in this case). e) If eBay is unable to find an image URL for the listing, an error is returned. See "Describing Items in a Listing" in the eBay Web Services Guide for additional information about working with pictures and related validation rules. You cannot remove Gallery or Plus or Featured when you revise a listing. Note that the Gallery Plus image enhancement does not support SiteHostedPicture. Use Item.PictureDetails with that feature. AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No Deprecated GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally Deprecated GetItem Conditionally Deprecated URL for a picture to be used as the Gallery thumbnail (item must be listed with the fee-based option to be in the Gallery or Gallery Featured). If the item is Gallery Featured, a value must be supplied for either GalleryURL or PictureURL. In either case: (a) If a URL is provided only for PictureURL, it is used as the gallery thumbnail. (b) If a URL is provided for both GalleryURL and PictureURL, then the picture indicated in GalleryURL is used as the thumbnail. The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery picture if it was previously specified. Not applicable to eBay Motors listings. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. For eBay Live Auctions, lots are listed in the gallery for free. 1024 AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem Conditionally Deprecated GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally Deprecated GetMyeBayBuying Conditionally BidList SecondChanceOffer Deprecated none, ReturnSummary, ReturnAll option to be in the Gallery or Plus or Gallery Featured). If the item is Gallery Featured, a value must GetItem Conditionally Deprecated none, ItemReturnDescription, ItemReturnAttributes, ReturnAll The service hosting the images in PictureURL, if any. This information is primarily useful for Picture Manager subscribers, who pay a flat subscription fee instead of individual picture fees per listing. Only returned when PictureURL is returned. GetItem Conditionally Deprecated ReturnAll SiteIDFilterCodeType - Type declaration to be used by other schema. This code identifies the SiteIDFilters to allow user to filter the category listings by SiteID. (in) Items listed in the currency implied by SiteID. (in) Items located in the country implied by SiteID. (in) Items available to the country implied by SiteID. (For the US site, this implies listings from ALL English-language countries that are available to the US.) (in) Items listed on the site implied by SiteID, regardless of listing currency. (in) Items located in Belgium or listed on one of the two Belgian sites. (out) Reserved for internal or future use. Contains the data that defines a site-based filter (used when searching for items and filtering the search result set). A filter to use when listing categories or items. GetSearchResults GetCategoryListings No A list of one or more characteristics sets mapped to the category, if any. Use this information when working with Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) functionality. Container for site-wide characteristics set information. GetCategory2CS Conditionally A category that does not support the specified site-wide characteristics set. GetCategory2CS Conditionally Indicates Skype contact options. (in/out) The Skype Chat contact option. (in/out) The Skype Voice contact option. Deprecated. Use values or values of SkypeContactOptionCodeType. (in/out) Deprecated. Use values or values of SkypeContactOptionCodeType. (in/out) Deprecated. Use values or values of SkypeContactOptionCodeType. Indicates the order in which the catalog search engine will sort the results if you pass a sort attribute (SortAttributeID) in search requests. Applications cannot change the sort order of a sort attribute. The results will be sorted by the specified attribute in ascending (low to high) order. GetMyeBayBuying No The results will be sorted by the specified attribute in descending (high to low) order. GetMyeBayBuying No (out) Reserved for internal or future use. Suggested spelling of mispelled search terms, along with the number of matching items that would have been returned if the suggestions had been used. The number of matching items if the suggested spelling of the search term or terms had been used. If multiple terms are used, MatchingItemCount applies to the terms taken as a unit. GetSearchResults Conditionally Suggestion for a different spelling of the search term or terms. The suggestions are given in Text tags and the suggestion for the first word is given before the suggestion for subsequent words. Suggestions are based on correctly-spelled terms in items, so suggestions vary over time and depend on whether a word or word combination is in one or more items. GetSearchResults Conditionally Specifies the type of action to carry out with SetStoreCategories. (in) Add the listed categories to the store. (in) Delete the listed categories from the store. (in) Move the listed categories from one place in the store category structure to another. (in) Rename the listed store categories to the names provided. (out) Reserved for internal or future use. Set of eBay Store color schemes. A Store color scheme. GetStoreOptions Always Store color scheme. Store color scheme ID. (use GetStoreOptions to get the list of valid theme color scheme IDs). SetStore Conditionally GetStore Conditionally GetStoreOptions Always Store color scheme name. Provides a user-friendly name for the color scheme. SetStore Conditionally GetStore Conditionally GetStoreOptions Always Store color set. SetStore Conditionally GetStore Conditionally GetStoreOptions Always Store font set. SetStore Conditionally GetStore Conditionally GetStoreOptions Always Store color set. Primary color for the Store. Specified in 6-digit Hex format. For example: F6F6C9 6 SetStore Conditionally GetStore Conditionally GetStoreOptions Always Secondary color for the Store. Specified in 6-digit Hex format. For example: F6F6C9 6 SetStore Conditionally GetStore Conditionally GetStoreOptions Always Accent color for the Store. Specified in 6-digit Hex format. For example: F6F6C9 6 SetStore Conditionally GetStore Conditionally GetStoreOptions Always Set of custom categories for the Store. A Store custom category. GetStore Always SetStore No Deprecated SetStoreCategories Yes Configuration of a store custom category. Custom category ID. 10 GetStore Always SetStore No Deprecated SetStoreCategories Yes Name of the custom category. GetStore Always SetStore No Deprecated SetStoreCategories Conditionally Order in which the custom category appears in the list of store categories. GetStore Always SetStore No Deprecated SetStoreCategories No Container for store custom subcategory configuration information. This field is being deprecated. Use ChildCategory to specify subcategories. SetStore No Deprecated Describes the configuration of a store custom subcategory. Stores support three levels of categories. GetStore Always SetStoreCategories Conditionally Specifies whether the Store has a custom header. Specifies that the Store does not have a custom header. Specifies that the Store does have a custom header. (out) Reserved for internal or future use. Specifies how the custom listing header will be displayed. No custom listing header is displayed. The full custom listing header is displayed. The full custom listing header and the left navigation bar is displayed. (out) Reserved for internal or future use. Specifies the type of link in the custom listing header. No type. Link is to an About Me page. Link is to a custom page. Link is to a custom category. (out) Reserved for internal or future use. Custom listing header link. Link ID for the listing header link. The ID is used when the link is a custom category or for a custom page, and it is not needed when the LinkType property is "AboutMe" or "None". SetStore Conditionally GetStore Conditionally Order in which to show the custom listing header link. SetStore Conditionally GetStore Conditionally Type of link to include in the custom listing header. SetStore Conditionally GetStore Conditionally Configuration of a Store custom listing header. Display type for the custom listing header. SetStore Conditionally GetStore Conditionally Specifies whether the custom header has a logo. SetStore Conditionally GetStore Conditionally Specifies whether the custom header has a search box. SetStore Conditionally GetStore Conditionally Link to include in the custom header. SetStore Conditionally GetStore Conditionally Specifies whether the custom header has a link to Add to Favorite Stores. SetStore Conditionally GetStore Conditionally Specifies whether the custom header has a link to Sign up for Store Newsletter. SetStore Conditionally GetStore Conditionally Specifies whether the bread crumb needs to be displayed above the listing header. SetStore Conditionally GetStore Conditionally Set of Store custom pages. A Store custom page. GetStoreCustomPage Always List of possible statuses for Store custom pages. (in,out) The page is visible. (in) The page is to be deleted. (in,out) The page is not visible. (out) Reserved for internal or future use. Name of the Store custom page. This value is required if you are creating a new page (by not specifying a PageID). Note that you must include a Name for the page even if you are using the PreviewEnabled tag. However, since using the preview functionality means that the page will not be persisted, you can enter a dummy value for this field if you have not decided on a name for the page. The Name is used in links to the page. GetStoreCustomPage Always SetStoreCustomPage Conditionally SetStoreCustomPage Conditionally Unique identifier for the Store custom page. When you are using SetStoreCustomPage, if you specify a valid PageID, the custom page is updated. If you do not specify a PageID, the custom page is added. GetStoreCustomPage Always SetStoreCustomPage Conditionally SetStoreCustomPage Conditionally The URL path of the custom page. Only if you are using Chinese characters in the Name property for the custom page do you need to use this field, such as if you are opening a Store on the Taiwan site. The reason for this is that the URL path is normally derived from the Store custom page name, but it cannot be derived from the name of the custom page if it contains Chinese characters because URLs cannot contain Chinese characters. URLPath is included in the GetStoreCustomPage response when PageID is specified. GetStoreCustomPage Conditionally SetStoreCustomPage Conditionally SetStoreCustomPage Conditionally Full URL of the Store custom page. URLPath is included in the GetStoreCustomPage response when PageID is specified in the request. GetStoreCustomPage Conditionally Status of the custom page, active or inactive. Set Status to Delete with SetStoreCustomPage to delete the page. GetStoreCustomPage Always SetStoreCustomPage Conditionally SetStoreCustomPage Conditionally The HTML content of the custom page. This field has a maximum size of 96 kilobytes. If PreviewEnabled is true, then this value is required. Otherwise, it is optional. GetStoreCustomPage Conditionally SetStoreCustomPage Conditionally SetStoreCustomPage Conditionally Specifies whether the left navigation bar is visible on the page. LeftNav is included in the GetStoreCustomPage response when PageID is specified in the request. GetStoreCustomPage Conditionally SetStoreCustomPage Conditionally SetStoreCustomPage Conditionally If true, then the other inputs are ignored, and the content of the page as it will be displayed within the Store is returned. If false, then the page is either modified or added, and the content of the page is not returned. SetStoreCustomPage No SetStoreCustomPage Conditionally Order in which the page is displayed in the list of custom pages. GetStoreCustomPage Always SetStoreCustomPage Conditionally SetStoreCustomPage Conditionally Font selection for Store configuration. (in,out) Arial font. (in,out) Courier font. (in,out) Times New Roman font. (in,out) Verdana font. (out) Reserved for internal or future use. Font size selection for Store configuration. (in,out) Extra extra small. (in,out) Extra small. (in,out) Small. (in,out) Medium. (in,out) Large. (in,out) Extra large. (in,out) Extra extra large. (out) Reserved for internal or future use. Store font set. Font for the Store name. SetStore Conditionally GetStore Conditionally GetStoreOptions Always Font size for the Store name. SetStore Conditionally GetStore Conditionally GetStoreOptions Always Font color for the Store name. Specified in 6-digit Hex format. For example: F6F6C9 6 SetStore Conditionally GetStore Conditionally GetStoreOptions Always Font for the Store section title. SetStore Conditionally GetStore Conditionally GetStoreOptions Always Font size for the Store section title. SetStore Conditionally GetStore Conditionally GetStoreOptions Always Font color for the Store section title. Specified in 6-digit Hex format. For example: F6F6C9 SetStore Conditionally GetStore Conditionally GetStoreOptions Always Font for the Store description. SetStore Conditionally GetStore Conditionally GetStoreOptions Always Font size for the Store description. SetStore Conditionally GetStore Conditionally GetStoreOptions Always Font color for the Store description. Specified in 6-digit Hex format. For example: F6F6C9 SetStore Conditionally GetStore Conditionally GetStoreOptions Always The full Store header is used. A minimized Store header is used. (out) Reserved for internal or future use. Set of available layouts for items listed in an eBay Store. Displays item list as a single column, with smaller item pictures. Displays item list in two columns, with larger item pictures. (out) Reserved for internal or future use. List of available options for how items are sorted in an eBay Store. (in,out) Lists items with those ending soon listed first. (in,out) Lists items with those newly listed appearing in the list first. (in,out) Lists items by price in ascending order. The item with the lowest starting price is listed first. (in,out) Lists items by price in descending order. The item with the highest starting price is listed first. (out) Reserved for internal or future use. Set of Store logos. A Store logo. GetStoreOptions Always Store logo. Store logo ID (use GetStoreOptions to get the list of valid logo IDs). SetStore Conditionally GetStore Conditionally GetStoreOptions Always Store logo name. Provides a user-friendly name for the logo. SetStore Conditionally GetStore Conditionally GetStoreOptions Always URL of the logo. Must have a .gif or .jpg extention. Specified when you are using a customized logo. SetStore Conditionally GetStore Conditionally Store Preferences type. Store vacation hold preferences. GetStorePreferences Conditionally SetStorePreferences No Identifies the StoreSearch codes (e.g., for GetSearchResults requests). (in) Within a single store for all items (specify store in SearchStoreFilterType.StoreName). (in) Within a single store for auction items (specify store in SearchStoreFilterType.StoreName). (in) Within a single store for basic fixed price items, Store Inventory format items, and auction items with Buy It Now. (Specify store in SearchStoreFilterType.StoreName). (in) Across all stores for basic fixed price items, Store Inventory format items, and auction items with Buy It Now. (out) Reserved for internal or future use. Set of eBay Store subscription levels. A Store subscription level. GetStoreOptions Always User's eBay Store subscription level. (in) Used to cancel the user's eBay Store subscription. (in,out) Basic level subscription. (in,out) Featured level subscription. (out) Anchor level subscription. (out) Reserved for internal or future use. Store subscription level. GetStoreOptions Always Monthly fee for the Store subscription level. GetStoreOptions Always Set of Store themes. A Store theme. GetStoreOptions Always Set of color schemes. This set is for use with those themes that do not explicitly list a color scheme in the theme definition (these themes are also known as advanced themes). GetStoreOptions Always AdvancedThemeArray Store theme. Store theme ID (use GetStoreOptions to get the list of valid theme IDs). SetStore Conditionally GetStore Conditionally GetStoreOptions Always Store theme name. Provides a user-friendly name for the theme. SetStore Conditionally GetStore Conditionally GetStoreOptions Always Theme color scheme. SetStore Conditionally GetStore Conditionally GetStoreOptions Always BasicThemeArray The configuration of an eBay Store. Name of the eBay Store. The name is shown at the top of the Store page. 35 SetStore Conditionally GetStore Always The URL path of the Store (58 characters maximum). Only if you are using Chinese characters in the Name property do you need to use this field, such as if you are opening a Store on the Taiwan site. The reason for this is that the URL path is normally derived from the Store name, but it cannot be derived from the name of the Store if it contains Chinese characters because URLs cannot contain Chinese characters. SetStore Conditionally GetStore Conditionally The complete URL of the user's Store. This field is only ever returned, and does not need to be explicitly set. SetStore Conditionally GetStore Conditionally Subscription level (tier) for the user's eBay Store. SetStore Conditionally GetStore Always Store description (300 characters maximum). SetStore Conditionally GetStore Always Store logo. SetStore Conditionally GetStore Conditionally Store theme. SetStore Conditionally GetStore Conditionally Style for the Store header. SetStore Conditionally GetStore Conditionally Page to use as the Store's homepage (default is 0). To change the homepage, specify the PageID of one of the Store's custom pages. SetStore Conditionally GetStore Conditionally The default layout type to use for the Store items. SetStore Conditionally GetStore Conditionally The default sort order to use for the items for sale in the Store. SetStore Conditionally GetStore Conditionally Layout for the Store's custom header. SetStore Conditionally GetStore Conditionally Custom header text for the Store. SetStore Conditionally GetStore Conditionally Specifies whether to export the Store listings to comparison shopping websites. SetStore Conditionally GetStore Conditionally Custom categories for the Store. Deprecated (input ignored) for SetStore with compatibility level 449 or higher. Use SetStoreCategories with compatibility level 449 or higher to modify store category structures. SetStore No Deprecated GetStore Always Custom listing header for the Store. SetStore Conditionally GetStore Conditionally Specifies the chosen customization display scheme for this store's Merch Widgets. See MerchDisplayCodeType for specific values. SetStore Conditionally GetStore Conditionally (out) Indicates the time the store was last opened or reopened. SetStore Conditionally GetStore Conditionally Specifies a set of Store vacation preferences. Specifies whether the Store owner is on vacation. When OnVacation is true, the Store owner's listings do not appear on Express, regardless of the listing format and regardless of how the seller has configured their vacation settings for items that appear on eBay. GetStorePreferences Always SetStorePreferences No Seller return date from vacation. GetStorePreferences Conditionally SetStorePreferences No Hide Store Inventory format items when the Store owner is on vacation. When OnVacation is true, the Store owner's listings do not appear on Express, regardless of the listing format and regardless of how the seller has configured their vacation settings for items that appear on eBay. GetStorePreferences Always SetStorePreferences No Add a message when the Store owner is on vacation to all their active items. GetStorePreferences Always SetStorePreferences No Add a message to all the Store pages when the Store owner is on vacation. GetStorePreferences Always SetStorePreferences No Display custom message on the Store pages instead of the default message. 10000 GetStorePreferences Always SetStorePreferences No The custom message to display for the Store when the user is on vacation. May contain HTML markup. GetStorePreferences Conditionally SetStorePreferences No Contains information related to the item in the context of a seller's eBay Store. Applicable for auction format, Basic Fixed Price, and Store Inventory format items listed by eBay Stores sellers. Numeric ID for a custom category that the seller created in their eBay Store, if any. eBay Stores sellers can create up to three levels of custom categories for their stores. Items can only be listed in store categories that have no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the Other store category. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Applicable for eBay Store sellers only. Numeric ID for a second custom category that the seller created in their eBay Store. eBay Stores sellers can create up to 300 custom categories for their stores. (One additional Store category cannot be customized and retains the value of "Other"). If you specify an invalid value, the values are the same for both the primary and secondary store categories, or if the seondary store category is specified but the primary is left blank (or other), the system resets the value to 0 (None). In short, the primary store category must be set to something meaningful and different from the second store category in order to set the secondary store category to a value other than 0. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll The URL of the seller's eBay Store page. Output only. GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetSearchResults Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll The name of the seller's eBay Store. GetSearchResults Conditionally (in) Indicates the type of string matching to use when a value is submitted in CharityName. If no value is specified, default behavior is "StartsWith." Does not apply to Query. (in) Reserved for internal or future use. (in) Matches strings that begin with the submitted value. For example, submitting a CharityName value of "heart" matches "Heart of Gold," but not "Open Hearts." Default behavior if no value is specified. (in) Matches strings that contain the submitted value. For example, submitting a CharityName value of "heart" matches both "Heart of Gold" and "Open Hearts." Contains an array of categories that contain listings with specified keywords in their titles or descriptions. The array can contain up to 10 categories. Describes a category that contains listings that match specified keywords in the query. Returned if a category matches the query. GetSuggestedCategories Conditionally Defines a suggested category, returned in response to a search for categories that contain listings with certain keywords in their titles and descriptions. Describes a category that contains items that match the query. GetSuggestedCategories Conditionally Percentage of the matching items that were found in this category, relative to other categories in which matching items were also found. Indicates the distribution of matching items across the suggested categories. GetSuggestedCategories Conditionally Details about a summary event schedule. The event type associated with this alert. SetNotificationPreferences Conditionally GetNotificationPreferences Conditionally The period of time for which to create a summary. SetNotificationPreferences Conditionally GetNotificationPreferences Conditionally How often the summary is to be delivered. SetNotificationPreferences Conditionally GetNotificationPreferences Conditionally How often the summary is to be delivered. Deliver every Sunday. Deliver every Monday. Deliver every Tuesday. Deliver every Wednesday. Deliver every Thursday. Deliver every Friday. Deliver every Saturday. On day 1 of the month. On day 2 of the month. On day 3 of the month. On day 4 of the month. On day 5 of the month. On day 6 of the month. On day 7 of the month. On day 8 of the month. On day 9 of the month. On day 10 of the month. On day 11 of the month. On day 12 of the month. On day 13 of the month. On day 14 of the month. On day 15 of the month. On day 16 of the month. On day 17 of the month. On day 18 of the month. On day 19 of the month. On day 20 of the month. On day 21 of the month. On day 22 of the month. On day 23 of the month. On day 24 of the month. On day 25 of the month. On day 26 of the month. On day 27 of the month. On day 28 of the month. On day 29 of the month. On day 30 of the month. On day 31 of the month. Every 31 days. Every 60 days. The period of time for which to create a summary. (in/out) The last 24 hours. (in/out) The last 7 days. (in/out) The last 31 days. (in/out) The current week. (in/out) The prior week. (in/out) The current month. (in/out) The prior month. (in/out) The last 60 days. Defines the Transaction Confirmation Request feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Status values for the processing progress for the category structure changes specified by a SetStoreCategories request. If the SetStoreCategories call is processed asynchronously, then the status is returned by GetStoreCategoryUpdateStatus, otherwise, the status is returned in the SetStoreCategories response. (out) The category changes have not started. (out) The category changes are in progress. (out) The category changes completed successfully. (out) The category changes failed. (out) Reserved for internal or future use. Tax-related details for a region or jurisdiction. Representative identifier for the jurisdiction. Typically an abbreviation (e.g. CA for California). GetBidderList GeteBayDetails GetItemShipping GetTaxTable GetSellerList Conditionally ReturnAll, none GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll SetTaxTable Yes The tax percent to apply for a listing shipped to this jurisdiction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). GetTaxTable: this tag has no value if the user's tax table has not been set. SetTaxTable Yes GetBidderList GetItemShipping GetSellerList GetTaxTable Conditionally ReturnAll, none GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll Whether shipping costs are to be part of the base amount that is taxed. GetTaxTable: This tag is empty if the user did not previously provide information. GetBidderList GetItemShipping GetSellerList GetTaxTable Conditionally ReturnAll, none GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll SetTaxTable Yes Full name for the jurisdiction or region for display purposes. GeteBayDetails Conditionally Sales tax details for zero or more jurisdictions (states, provinces, etc). Sales tax details for zero or more jurisdictions (states, provinces, etc). For GetTaxTable, if DetailLevel is not specified, information is only returned for the jurisdictions for which the user provided tax information. If DetailLevel is ReturnAll, tax information is returned for all possible jurisdictions, whether specified by the user or not. ShippingIncludedInTax and SalesTaxPercent are returned but are empty. SetTaxTable Yes GetTaxTable Always ReturnAll, none GetOrderTransactions Conditionally none, ReturnAll GetSellerList Conditionally ItemReturnDescription, ReturnAll GetBidderList GetItemShipping Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally Data for one theme group. Returned for GetDescriptionTemplates if theme groups are requested. Unique identifier for this theme group. GetDescriptionTemplates Conditionally Name of this theme group (localized to the language associated with the eBay site). GetDescriptionTemplates Conditionally Unique identifier for each theme in this group. There is at least one theme in a theme group. GetDescriptionTemplates Conditionally The number of ThemeID elements in this group. GetDescriptionTemplates Conditionally Used to specify how the application wants eBay to handle the user's token after the user signs in. There are two options: redirect with token, or leave the token at eBay and fetch the token through an API call to FetchToken. (out) Return the token in the HTTP redirect to the application-specified accept URL (out) Leaves the token at eBay so that the application can get the token through the FetchToken API call (SecretId required) (out) Reserved for internal or future use Specifies a person's role in doing business on eBay. (out) The buyer. (out) The seller. (out) Reserved for internal or future use. (out) Contains an array of transactions. Information about one transaction. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none GetItemsAwaitingFeedback Conditionally GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally GetMyeBayBuying Conditionally WonList AddOrder Yes Specifies the site on which the purchase was made. The transaction was created (i.e., the purchase was made) on the main eBay site. The transaction was created on the eBay Express site. Contains the status of the transaction, such as the buyer's online payment and whether the checkout process for the transaction has been completed. Indicates the success or failure of the buyer's online payment for a transaction. Only applicable if the buyer chose PayPal as the payment method for the transaction. If the payment failed, the value returned indicates the reason for the failure. Output only. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions none Conditionally Indicates the current status of the checkout process for the transaction. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions none Conditionally Indicates date and time a transaction's status or incomplete state was last updated (in GMT). GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions none Conditionally (out) Payment method the buyer selected for paying the seller for the transaction. If checkout is not yet complete, PaymentMethodUsed is set to whatever the buyer selected as his or her preference on the Review Your Purchase page. GetOrders Always GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions none Conditionally Indicates whether the transaction process is complete or incomplete. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions none Conditionally Indicates whether the buyer has selected shipping details during checkout. False indicates that the shipping service was selected by eBay for the buyer. For example, if the buyer has not yet completed the Review Your Purchase page, he has not picked a shipping service. If it is false, the application should ignore ShippingServiceCost and ShippingServiceSelected (items whose values are defaulted by eBay). GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions none Conditionally Contains information about a single transaction. A transaction contains information about the sale one or multiple items from a listing to a single buyer. The eBay system creates a transaction when a buyer has made a purchase (fixed-price listings) or is the winning bidder (BIN and competitive-bidding listings). A listing can spawn one or more transactions in these cases: multi-item fixed-price listings and Dutch listings. A listing can spawn only a single transaction in these cases: single-item fixed-price listings and Chinese listings. The amount the buyer paid for the item(s) in the transaction. If the seller allowed the buyer to change the item total, the buyer is able to change the total until the time that the transaction's status moves to Complete. Determine whether the buyer changed the amount by retrieving the transaction data and comparing the AmountPaid value to what the seller expected. For Motors items, AmountPaid is the amount paid by the buyer for the deposit. Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none Adjustment amount entered by the buyer. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller. Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none Converted value of AdjustmentAmount in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none Contains the data for the transaction's buyer. See UserType for its child elements. Not applicable to Half.com except for GetOrders. GetItemsAwaitingFeedback GetMyeBaySelling GetOrders Conditionally GetOrderTransactions Conditionally none, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. For GetOrders, also applicable to Half.com. For GetOrders, minimal ShippingDetails information is returned under the Transaction container. GetOrders Always GetOrderTransactions Always none GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Shipping http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Shipping Converted value of AmountPaid in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none Converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none Indicates when the transaction was created. For fixed-price, Stores, and BIN items this indicates when the purchase (or BIN) occurred. For competitive-bidding listing types this indicates when listing ended, the winning bidder(s) determined, and the transaction created. For GetOrders, only applicable to Half.com. GetOrders Always GetOrderTransactions Always none GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally Deposit type for US eBay Motors items. If item is not a Motors item, then returns an empty value for DepositType. See DepositTypeCodeType for specific values. Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none Information about the item that spawned the transaction. It is a purchase from this item's listing that the transaction represents. To remove a property from an item, specify it in ModifyType as a changed property, but do not give it a value in Item. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none GetMyeBayBuying Conditionally WonList GetItemsAwaitingFeedback GetMyeBaySelling Conditionally AddOrder Yes GetSellerTransactions none, ItemReturnDescription, ReturnAll Always Indicates the number of items the buyer purchased from the listing identified in ItemID. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none GetMyeBayBuying Conditionally WonList GetMyeBaySelling Conditionally SoldList GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally Contains the status of the transaction, such as the buyer's online payment and whether the checkout process for the transaction has been completed. See TransactionStatusType for its child elements. Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none Identifier for the transaction. A value of zero is used for the Chinese auction format. Thus, a value of zero is a valid transaction ID. A transaction ID is only unique to the listing that spawned it, so a transaction is only uniquely identified on a global basis by a combination of ItemID and TransactionID. Also applicable to Half.com (for GetOrders). 10 GetOrders Always GetOrderTransactions Always none GetMyeBayBuying Conditionally WonList GetMyeBaySelling Conditionally SoldList GetItemsAwaitingFeedback Conditionally GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally AddOrder Yes Price of the transaction (before shipping and sales tax) that the buyer needs to pay to complete the purchase. For eBay Motors, TransactionPrice is the deposit amount. Also applicable to Half.com (for GetOrders). GetOrders Always GetOrderTransactions Always none GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally Whether the transaction was completed with the seller selecting a best offer. Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none VAT rate for the item. When the VATPercent is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a VATPercent, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max precision 3 decimal places. Max length 5 characters. Note: The View Item page displays the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored. Not applicable to Half.com. A PayPal transaction that relates to this eBay transaction. Returned only if there is at least one PayPal transaction related to this eBay transaction. Not applicable to Half.com. GetItemTransactions GetSellerTransactions Conditionally ReturnAll GetOrderTransactions Conditionally none Not applicable to Half.com. GetItemTransactions GetSellerTransactions Conditionally none, ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none The shipping service selected by the buyer from the services offered by the seller. Not applicable to Half.com. GetItemTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none Shipping http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Shipping Display message from buyer. This field holds transient data that is only being returned in the notification flow. This field is only returned in the Checkout related notifications. Not applicable to Half.com. This field holds the Dutch Auction Offer Bid by the buyer in this transaction, if this is a Dutch Auction Item. This field will only be returned if caller has set IncludeDuctionAuctionBid to true. Not applicable to Half.com. Specifies the transaction's paid status, as seen by the buyer. Returned in lists of won and sold items. Not applicable to Half.com. GetMyeBayBuying Conditionally WonList GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally GetOrderTransactions Conditionally none Specifies the transaction's payment status, as seen by the seller. Returned in lists of won and sold items. Not applicable to Half.com. GetMyeBaySelling Conditionally SoldList Indicates the time when the transaction was marked paid, if known. The value is set by eBay when payment is made via PayPal or a third-party checkout flow. This value is also set when the seller marks the item as paid by using ReviseCheckoutStatus or CompleteSale. The seller can also mark the item as paid by using My eBay or Selling Manager Pro. Note that this value is only visible if the request user is the buyer or seller associated with the transaction. If the item is marked as paid but the seller is not a Selling Manager Pro user, PaidTime returns the transaction creation time instead. Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none Indicates the time when the item(s) associated with the transaction were marked as shipped, if known. The value is set when the seller uses shipment tracking features offered by eBay or an eBay partner. This value is also set when the seller marks the item as shipped by using CompleteSale. If the seller is a Selling Manager Pro user, they can also mark the item as shipped by using My eBay. Note that this value is only visible if the request user is the buyer or seller associated with the transaction. Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none Not applicable to Half.com. Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally GetOrderTransactions Conditionally none GetMyeBayBuying Conditionally WonList Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally GetOrderTransactions Conditionally none GetMyeBayBuying Conditionally WonList The order to which the transaction belongs. You are charged a Final Value Fee if your item is sold, ends with a winning bid, or is purchased. This fee applies whether or not you actually complete the sale with the buyer. If you request a Final Value Fee Credit, the value of Transaction.FinalValueFee will not change for the item if a credit is issued. (The credit only appears in the seller's account data.) See the eBay.com Web site online help for more information about the Final Value Fee. The Final Value Fee for FixedPriceItem, StoresFixedPrice, and Buy It Now Dutch listing types is returned by GetSellerTransactions and GetItemTransactions on a transaction by transaction basis. For all other listing types, including Chinese and Dutch (no Buy It Now purchases), the Final Value Fee is returned when the listing status is Completed. If the item was a Dutch auction that ended with bids (not Buy It Now purchases), the Final Value Fee is returned in Item.SellingStatus.FinalValueFee. For all other listing types, including Dutch auctions that end with Buy It Now purchases, the Final Value Fee is returned in Transaction.FinalValueFee. Not applicable to Half.com. GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none Indicates the platform the item was purchased on (such as eBay or eBay Express). Not applicable to Half.com. GetMyeBayBuying Conditionally WonList GetMyeBaySelling Conditionally SoldList GetItemTransactions GetSellerTransactions none, ItemReturnDescription, ReturnAll Always GetOrderTransactions Always none, ReturnAll The name of the store, if Item.ThirdPartyCheckout is true. GetItemTransactions GetOrders GetSellerTransactions none, ItemReturnDescription, ReturnAll Conditionally GetOrderTransactions Conditionally none UPS Rate Options UPS Daily Rates UPS On-Demand Rates Reserved for internal or future use Details about a specific eBay URL. A compressed, representative title for the eBay URL. GeteBayDetails Conditionally A commonly used eBay URL. Applications use some of these URLs (such as the View Item URL) to launch eBay Web site pages in a browser. Logo URLs are required to be used in certain types of applications. See your API license agreement. Also see this page for logo usage rules: http://developer.ebay.com/join/licenses/apilogousage GeteBayDetails Conditionally A compressed, representative title for the eBay URL. URL Prefix for viewing a particular listing. Just add an item id. URL Prefix for viewing the feedback for a particular userid. Just add a userid. Full URL for an eBay login page. Full URL for viewing the items on which the user is bidding. Full URL for viewing the items on which the user bid but did not win. Full URL for viewing the items on which the user bid and also won. Full URL for viewing the items the user is currently watching. Full URL for eBay Stores. Full URL for the small version of the "An eBay Marketplace" logo. Full URL for the medium version of the "An eBay Marketplace" logo. Full URL for the large version of the "An eBay Marketplace" logo. Reserved for future use. Units of measure used to express such properties as weight and size dimensions. (in/out) Kilograms (in/out) Pounds (in/out) Ounces (in/out) Centimeters (in/out) Inches (in/out) Feet (out) Reserved for internal or future use. Defines the UserConsentRequired feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Reserved for future use. Reserved for future use. (out) An eBay ID that uniquely identifies a user. One of the data filters used when searching for items using GetSearchResults. Allows filtering based on the eBay user IDs of sellers. May be used to limit the list of found items to just those listed by one or more specified sellers. Or may be used to limit the list to those items NOT listed by specified excluded sellers. Specifies a list of one or more eBay user IDs that represent sellers whose item listings should NOT be returned in the search result set. That is, the sellers' items are excluded from the search results. GetSearchResults No Specifies a list of one or more eBay user IDs that represent sellers whose item listings are returned in the search result set (and only listings by the specified sellers. That is, the sellers' items are included in the search results. GetSearchResults No UserStatusCodeType - Type declaration to be used by other schema. These codes indicate the current state or status of a an eBay user account. (out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem (out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement (out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category (out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email (out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay (out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status (out) Records for the specified user have been deleted (out) User has completed registration and confirmation, but is pending a verification of credit card information (out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items (out) User record has been merged with another account record for the same user (out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email (out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user (out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending (out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the verification of credit card information is still pending (out) Obsolete; signing in with Microsoft Passport is no longer supported GetUser Conditionally Obsolete (out) Obsolete; signing in with Microsoft Passport is no longer supported GetUser Conditionally Obsolete (out) Half.com User; user has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending (out) Reserved for internal or future use Type to contain the data for one eBay user. Depending on the context, the user might be the seller or the buyer in a transaction, or the bidder or winning bidder in a listing. An object of this type is returned by a number of calls, including the GetUser call. If true, indicates that the user has set up an About Me page. GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer GetAllBidders GetBidderList GetHighBidders Always Unique identifier for the user that does not change when the eBay user name is changed. Use when an application needs to associate a new eBay user name with the corresponding eBay user. GetUser Conditionally GetOrderTransactions Conditionally none, ReturnAll GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetHighBidders Always REST token (if available) for the user who is making the request. Not returned when UserID is for a different user than the one identified in eBayAuthToken. Use the REST token to authenticate REST API calls. For more information about REST tokens and the REST API, see http://developer.ebay.com/rest/. GetUser ReturnAll Conditionally Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. Based on Trust and Safety policies, the time is unspecified and can vary by site. GetAllBidders GetBestOffers GetBidderList GetHighBidders GetOrders GetUser Conditionally GetOrderTransactions Conditionally none, ReturnAll GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetMyeBayBuying Conditionally WonList GetMyeBaySelling Conditionally SoldList GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetSellerList Conditionally Seller ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer GetSellerEvents Conditionally ReturnAll The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. To be eligible to list on Express, a seller's feedback score needs to be 100 or higher. See "eBay Express" in the eBay Web Services guide. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. GetAllBidders GetCategoryListings GetHighBidders GetUser GetSearchResults Conditionally GetItem Conditionally none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetBestOffers GetBidderList Always GetOrderTransactions Conditionally none, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer GetSearchResultsExpress Conditionally GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetSellerEvents Conditionally ReturnAll Total count of negative feedback entries from unique (distinct) users. GetBidderList GetUser Conditionally Total count of positive feedback entries from unique (distinct) users. Contains the aggregate feedback score for a user. A member's feedback score is the net positive feedback minus the net negative feedback left for the member. Feedback scores are a quantitative expression of the desirability of dealing with that person as a Buyer or a Seller in auction transactions. Each auction transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). This rating is commonly expressed as the eBay Feedback score for the user. GetBidderList GetUser Conditionally Percent of total feedback that is positive. For example, if the member has 50 feedbacks, where 49 are positive and 1 is neutral or negative, the positive feedback percent could be 98.0. The value uses a max precision of 4 and a scale of 1. If the user has feedback, this value can be returned regardless of whether the member has chosen to make their feedback private. Not returned if the user has no feedback. To be eligible to list on Express, a seller's feedback percent needs to be 98 or higher. See "eBay Express" in the eBay Web Services guide. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. GetBidderList GetCategoryListings GetSearchResults GetUser Conditionally GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private. To be eligible to list on Express, a seller's feedback needs to be public. See "eBay Express" in the eBay Web Services guide. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. GetCategoryListings GetSearchResults GetUser Conditionally GetAllBidders GetBidderList GetHighBidders Always GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values. GetUser Conditionally GetAllBidders GetBidderList GetHighBidders Always GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer Indicates whether the user has been verified. For more information about the ID Verify program, see: http://pages.ebay.com/help/policies/identity-idverify.html GetUser Conditionally GetAllBidders GetBidderList GetHighBidders Always GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetOrderTransactions Conditionally none, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer If true, indicates that the user is in good standing with eBay. GetUser Conditionally GetAllBidders GetBidderList GetHighBidders Always GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged). GetUser Conditionally GetAllBidders GetBidderList GetHighBidders Always GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer Registration address for a user. eBay always returns complete RegistrationAddress details (including Phone) when you retrieve your own user data. RegistrationAddress for another user (except for Phone) is only returned if you have a transactional relationship with that user AND that user is registered on DE/AT/CH, regardless of your registration site and the site to which you send the request. To be eligible to list on Express US, a seller's registration address must be in the US or Canada. To list on Express Germany, a seller's registration address must be in Germany. See "eBay Express" in the eBay Web Services guide. GetItem GetUser Conditionally ReturnAll Indicates the date the specified user originally registered with eBay. GetAllBidders GetBestOffers GetBidderList GetHighBidders Always GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItem Conditionally HighBidder GetOrderTransactions Conditionally none, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer eBay site the user is registered with. To be eligible to list on Express US, a seller must be registered on the eBay US or Canada site. To be eligible to list on Express Germany, a seller must registered on the eBay Germany site. See "eBay Express" in the eBay Web Services guide. GetAllBidders GetBidderList GetHighBidders Always GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer Indicates the user's registration/user status. To be eligible to list on Express, a seller's status must be Confirmed. See "eBay Express" in the eBay Web Services guide. GetAllBidders GetBidderList GetHighBidders Always GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer Unique eBay user ID for the user. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. PlaceOffer Always GetAllBidders GetBestOffers GetBidderList GetHighBidders Conditionally GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemsAwaitingFeedback Conditionally Buyer GetMyeBayBuying Conditionally BestOfferList HighBidder LostList Seller WonList GetMyeBaySelling Conditionally ActiveList SoldList GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer GetSearchResultsExpress Conditionally GetSellerEvents Conditionally ReturnAll If true, identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser). GetAllBidders GetBidderList GetHighBidders Always GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer Date and time the user's data was last changed (in GMT). GetAllBidders GetBidderList GetHighBidders Always GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT). GetAllBidders GetBidderList GetHighBidders Always GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetOrderTransactions Conditionally none, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements. GetAllBidders GetHighBidders Always GetBidderList Conditionally Bidder GetOrderTransactions Conditionally none, ReturnAll GetSellerList Conditionally HighBidder ItemReturnDescription, ReturnAll GetItem Conditionally HighBidder none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Buyer GetMyeBaySelling Conditionally SoldList Contains information about the user as a seller, such as whether the seller is authorized to list Live Auctions items or opts to have items cross-promoted. See SellerType for its child elements. GetAllBidders GetBidderList Always GetUser Conditionally GetItem Always Seller none, ItemReturnDescription, ItemReturnAttributes, ReturnAll GetSellerList Always Seller none, ItemReturnDescription, ReturnAll GetItemTransactions GetSellerTransactions none, ReturnAll Always Seller Contains information about the seller's charity affliations. Returned if the user is affiliated with one or more charities. GetUser Conditionally GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Contains information about the seller with the eBay Giving Works provider charity seller account. The user's PayPal account level. Only returned for the user identified in eBayAuthToken. That is, you cannot see someone else's PayPal account level. Use this information to check whether a seller is eligible to specify Item.DigitalDeliveryDetails in listing requests. See the eBay Web site online help for current PayPal requirements for listing digital items. GetUser Conditionally The user's PayPal account type. Only returned for the user identified in eBayAuthToken. That is, you cannot see someone else's PayPal account type. Use this information to check whether a seller is likely to be eligible to specify Item.DigitalDeliveryDetails in listing requests. See the eBay Web site online help for current PayPal requirements for listing digital items. Please note that this information cannot necessarily be used to determine whether a seller is eligible to list items on eBay Express, because a seller can have more than one PayPal account (and any of these accounts can be used for a given listing). GetUser Conditionally The user's PayPal account status. Only returned for the user identified in eBayAuthToken. That is, you cannot see someone else's PayPal account status. Use this information to check whether a seller is eligible to specify Item.DigitalDeliveryDetails in listing requests. See the eBay Web site online help for current PayPal requirements for listing digital items. GetUser Conditionally Specifies the subscription level for a user. GetUser Conditionally If the user is a registered eBay China site user, this indicates whether the user has been verified. This value is based on the user's registration site, not the site that was specified in the request. If true, the China site user is verified. If false, the China site user is unverified. Not applicable to users who are not registered China site users. GetAllBidders GetBidderList Conditionally GetItemTransactions GetSellerTransactions none, ReturnAll Conditionally Indicates the Skype name of the user. Available if the seller has a Skype account and has linked it (on the eBay site) with his or her eBay account. GetUser Conditionally Indicates whether a user has read-only access to the eBay Wiki (true) or whether the user is able contribute or edit articles on the eBay Wiki (false). By default, all registered eBay users have access to contribute and edit articles on the eBay Wiki. All content contributed to the eBay Wiki is subject to the Community Content Policy. false GetUser none, ReturnAll Always Reserved for future use. GetUser Conditionally Reserved for future use. GetUser Conditionally Reserved for future use. AddItem ReviseItem VerifyAddItem Conditionally GetUser GetSellerList GetItem Conditionally GetSellerList Conditionally Seller ItemReturnDescription, ReturnAll Reserved for future use. GetUser Conditionally Container for eBay's Business User 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. Currently, the eBay Germany (DE), Austria (AT), and Switzerland (CH) sites support B2B business features. (in) If true, this indicates that the seller is a business user and intends to use listing features that are offered to business users only. Applicable only to business sellers residing in Germany, Austria, or Switzerland who are listing in a B2B VAT- enabled category on the eBay Germany (DE), Austria (AT), or Switzerland (CH) sites. The seller must have a valid VAT ID registered with eBay. This must be set to true if RestrictedToBusiness is true. It has no effect if RestrictedToBusiness is false. If an item was not qualified as a business item when originally listed, but meets the conditions for business items when the item is revised or relisted, the seller can convert the item to a business item by specifying the appropriate VAT details. See the eBay Web Services guide for more information and additional rules. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally If true, this indicates that the seller elects to offer the item exclusively to business users. If false, this indicates that the seller elects to offer the item to all users. Applicable only to business sellers residing in Germany, Austria, or Switzerland who are listing in a B2B VAT-enabled category on the eBay Germany (DE), Austria (AT), or Switzerland (CH) sites. If this argument is true, the seller must have a valid VAT-ID registered with eBay, and BusinessSeller must also be true. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem Conditionally VAT rate for the item. When the VATPercent is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a VATPercent, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max precision 3 decimal places. Max length 5 characters. Note: The View Item page displays the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem Conditionally GetBidderList GetItem Conditionally Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT). (out) VAT is not applicable (out) Residence in a country with VAT and user is not registered as VAT-exempt (out) Residence in a country with VAT and user is registered as VAT-exempt (out) Reserved for internal or future use The descriptive name of an attribute or characteristic value (e.g., "New" might be a literal value for a Condition attribute). In item-listing requests, if you send ValueID with an id of -3 or -6, you must use ValueLiteral to enter the value the user specified. Otherwise, eBay treats the request as if no value was sent at all. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value.ValueLiteral. The max length allowed varies per attribute. For Half.com, use AttributeArray.Attribute.Value.ValueLiteral. 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, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings. see description AddItem AddLiveAuctionItem GetItemRecommendations GetProductSearchResults GetSearchResults RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem Conditionally GetBidderList GetCategoryListings GetItemRecommendations GetSearchResults Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll GetOrders Always GetProductFamilyMembers GetProductSearchResults Always (out) Reserved for future use. Suggested alternative text for ValueLiteral. Multiple SuggestedValueLiteral elements can be returned in a Value node. Not applicable to Half.com. Constant value that identifies the attribute or characteristic in a language-independent way. Unique within the characteristics set. In item-listing requests, if the ID is -3 or -6 (Other), use ValueLiteral to specify the value that the user entered. In item-listing requests and product searches, the possible ID values are: -3 = User entered an arbitrary value (not an "Other" field) -6 = User entered a value in an "Other" field -100 = Value not specified (null) #### (positive integer) = Identifier for a pre-defined value that the user selected (e.g., 1001) For eBay.com, required if ValueList is specified. Not applicable to Half.com. AddItem AddLiveAuctionItem GetItemRecommendations GetProductSearchResults GetSearchResults RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem AttributeSetArray Conditionally GetBidderList GetCategoryListings GetItemRecommendations GetSearchResults Conditionally GetItem Conditionally ItemReturnAttributes, ReturnAll GetProductFamilyMembers GetProductSearchResults Always Defines the ValuePack feature (a feature pack). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Data for images hosted on a location of the seller's choice (other than eBay). Specify 1 PictureURL value and up to 5 SelfHostedURL values. With compatibility level 439 and higher, deprecated in the response in favor of Item.PictureDetails. With the future deprecation of VendorHostedPicture as input, Applications should use Item.PictureDetails instead. Note that the Gallery Plus image enhancement does not support VendorHostedPicture. Use Item.PictureDetails with that feature. (in/out) Deprecated with compatibility level 383 and higher. Contains the URL for an image hosted on a location of the seller's choice (other than eBay) and associated with an item. If specified, this cannot have an empty/null value. You cannot specify multiple PictureURL fields. In most cases, the picture URL is also used for the picture at the top of the View Item page on the Web site. For listing calls (e.g., AddItem): With compatibility levels lower than 383, specify 1 PictureURL argument. With compatibility 383 and higher, see SelfHostedURL instead. With the future deprecation of VendorHostedPicture as input, applications should use Item.PictureDetails.PictureURL instead. See Item.PictureDetails.PictureURL for information about how to remove pictures from a listing. For retrieval calls (e.g., GetItem): With compatibility levels lower than 383, PictureURL is returned. With compatibility levels between 383 and 439, SelfHostedURL is returned instead. With compatibility 439 and higher, Item.PictureDetails.PictureURL is returned instead. Note that the Gallery Plus image enhancement does not support VendorHostedPicture. Use Item.PictureDetails with that feature. 150 AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No Deprecated GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally Deprecated GetSellerList Conditionally ItemReturnDescription, ReturnAll Deprecated GetItem Conditionally Deprecated none, ItemReturnDescription, ItemReturnAttributes, ReturnAll (in/out) URL for multiple, self-hosted pictures (if any) that are stored/hosted at a non-eBay site and used for the item. If specified, do not pass an empty/null value. On the main eBay site, if you specify multiple SelfHostedURL fields in listing calls, PhotoDisplay must be set to VendorHostedPictureShow. For listing calls (e.g., AddItem): With compatibility levels lower than 383, specify 1 PictureURL field. With compatibility 383 and higher, specify up to 6 SelfHostedURL fields. For eBay Live Auctions, specify up to 5 SelfHostedURL fields. With the future deprecation of VendorHostedPicture as input, Applications should use Item.PictureDetails.PictureURL instead. For retrieval calls (e.g., GetItem): With compatibility levels lower than 383, PictureURL is returned. With compatibility levels between 383 and 439, SelfHostedURL is returned. With compatibility 439 and higher, Item.PictureDetails.PictureURL is returned. 150 AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No Deprecated GetBidderList GetMyeBaySelling Conditionally Deprecated GetSellerList Conditionally ItemReturnDescription, ReturnAll Deprecated GetItem Conditionally Deprecated none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL. Cannot be used in combination with Listing Designer layouts. Specify None or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0. GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally Deprecated GetSellerList Conditionally ItemReturnDescription, ReturnAll Deprecated GetItem Conditionally Deprecated none, ItemReturnDescription, ItemReturnAttributes, ReturnAll URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. eBay Live Auctions lots are listed in the gallery for free. With the future deprecation of VendorHostedPicture as input, Applications should use Item.PictureDetails.GalleryURL instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery picture if it was previously specified. Not applicable to eBay Motors listings. See "Describing Items in a Listing" in the If the value of GalleryType is Gallery or Plus or Featured, see eBay Web Services Guide for additional validation rules. Note that the Gallery Plus image enhancement does not support VendorHostedPicture. Use Item.PictureDetails with that feature. 1024 AddItem AddLiveAuctionItem GetItemRecommendations RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem No Deprecated GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally Deprecated GetSellerList Conditionally ItemReturnDescription, ReturnAll Deprecated GetMyeBayBuying Conditionally BidList SecondChanceOffer Deprecated none, ReturnSummary, ReturnAll GetItem Conditionally Deprecated none, ItemReturnDescription, ItemReturnAttributes, ReturnAll Indicates whether a picture for the item is included in the Gallery and, if so whether the item is also featured or Plus in the Gallery. If the value is Gallery or Plus or Featured, eBay checks the available image URLs in the following order to determine which URL to use (if more than one of these URLs is available): a) Use the URL in GalleryURL, if it is specified. b) Otherwise, if ProductListingDetails.UseStockPhotoURLAsGallery is true, use the eBay stock photo. c) Otherwise, use the value of the first SelfHostedURL in the array of SelfHostedURL fields, if any. d) Otherwise, if ProductListingDetails.ProductID is specified, use the eBay stock photo (eBay resets UseStockPhotoURLAsGallery to true in this case). e) If eBay is unable to find an image URL for the listing, an error is returned. See "Describing Items in a Listing" in the eBay Web Services Guide for additional information about working with pictures and related validation rules. You cannot remove Gallery or Plus or Featured when you revise a listing. AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No Deprecated GetSellerList Conditionally ItemReturnDescription, ReturnAll Deprecated GetBidderList GetCategoryListings GetMyeBaySelling GetSearchResults Conditionally Deprecated GetItem Conditionally Deprecated Container for verified user requirements. (in/out) If true, blocks bidding by users who do not pass a simple check (for example, for credit card on file). See "Buyer Requirements - VerifiedUser" in the chapter "Field Differences for eBay Sites." false AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem GetSellerList Conditionally (in/out) This field is ignored unless VerifiedUser is true. If this field is present, the user's feedback score is also considered: a user is blocked from bidding if the user's feedback score is less than or equal to the value of this field. 5 AddItem GetItemRecommendations RelistItem ReviseItem VerifyAddItem No GetBidderList GetItem GetSellerList Conditionally (out) Container for a list of search result items. Can contain zero, one, or multiple WantItNowPostType objects, each of which contains data for a single Want It Now post found by the search. (out) Contains data for a Want It Now post found by a search. GetWantItNowSearchResults Conditionally Contains the data describing a single Want It Now post. Buyers create Want It Now posts to communicate to sellers specific requirements for items they would like to buy. (out) ID of the category in which the Want It Now post is listed. 10 GetWantItNowSearchResults Conditionally GetWantItNowPost Always (out) Description of a Want It Now post. Description will not be returned for GetWantItNowSearchResults. GetWantItNowPost Always (in/out) ID that uniquely identifies a Want It Now post. GetWantItNowSearchResults Conditionally GetWantItNowPost Always (out) Site where the Want It Now post is listed. GetWantItNowSearchResults Conditionally GetWantItNowPost Always (out) Date and time (in GMT) that a Want It Now post was added. GetWantItNowSearchResults Conditionally GetWantItNowPost Always (out) Number of responses for a Want It Now post. Sellers respond to a Want It Now post by submitting an item number, so each response corresponds to an item listing. GetWantItNowSearchResults Conditionally GetWantItNowPost Always (out) Title of a Want It Now post. GetWantItNowSearchResults Conditionally GetWantItNowPost Always Describes an XSL file that would be returned from an Item Specifics or Pre-filled Item Information meta-data call (such as GetAttributesXSL or GetProductFinderXSL). The name of the XSL file. Store this information to use it as input to the call in the future. GetAttributesXSL GetProductFinderXSL Always ReturnAll The version number of the XSL file. Store this information to use it as input to the call in the future. GetAttributesXSL GetProductFinderXSL Always none, ReturnAll Contains a MIME base-64-encoded representation of the XSL file. See the eBay Web Services Guide for information on decoding the XSL stylesheet file. If no XSL file is available (or if you passed no detail level), this property is empty or not returned. GetAttributesXSL GetProductFinderXSL Always ReturnAll Contains a seller's preferences for listing items on Ebay Express. If true: The seller wants their eligible eBay listings to be included on eBay Express (in addition to the main eBay site). If false: The seller does not want their listings to be included on eBay Express. If omitted (in SetUserPreferences): The seller does not want to change their existing preference. (Initially, eBay sets this preference to true for every seller.) GetUserPreferences Deprecated Conditionally SetUserPreferences omitted ObsoleteSoon No Version 471