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 Enables a seller to create a new Unpaid Item dispute. (Item Not Received disputes can only be created via the eBay web site.)

Enables a seller to create a new Unpaid Item dispute. (Item Not Received disputes can only be created via the eBay web site.)

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes 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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemNotReceivedDisputes 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemNotReceivedDisputes 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).

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingItemsIntro http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AddItem half Child elements hold the values that define the new item. Item is a required input. Also applicable to Half.com. AddItem Yes 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FinalValueFeesAndCredits http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeesPerSite http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UsingFeaturePacks 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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=addLiveAuctionItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=LiveAuctions 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 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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AddMemberMessageAAQToPartner AddMemberMessagesAAQToBidder,AddMemberMessageRTQ 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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers AddMemberMessagesAAQToBidder,AddMemberMessageAAQToPartner 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. The call can be used with Motors or Business & Industrial categories only.

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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers AddMemberMessageAAQToPartner, AddMemberMessageRTQ 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, enabling a buyer to pay for all of those transactions with a single payment (and, if so arranged, ship all of the items together). <br><br> Strong recommendation: 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, enabling a buyer to pay for all of those transactions with a single payment (and, if so arranged, ship all of the items together).

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=WorkingWithCombinedPayment 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 (that is, an offer for an unsold item) for one of that item's non-winning bidders.

Creates a new Second Chance Offer (that is, an offer for an unsold item) for one of that item's non-winning bidders.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MakingSecondChanceOffersForItems 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. AddSecondChanceItem Yes The amount the offer recipient must pay to purchase the item from the second chance offer listing. Use only when the original item was listed in an eBay Motors vehicle category (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. AddSecondChanceItem No 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. AddSecondChanceItem 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) AddSecondChanceItem Yes 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 AddSecondChanceItem No AddSecondChanceItem response for a new Second Chance Offer listing. Contains the item ID for the new second chance offer listing. Different from the original ItemID passed in the request. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddSecondChanceItem Always Indicates the date and time when the the new second chance offer listing became active and the recipient user could purchase the item. AddSecondChanceItem 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). AddSecondChanceItem Always Appends a horizontal rule, then a message about what time the addition was made by the seller, and then the seller-specified text.

Appends a horizontal rule, then a message about what time the addition was made by the seller, and then the seller-specified text.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ChangingItemDescriptions 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 (if listed for at least 24 hours) and creates a new Transaction Confirmation Request (TCR) for an item, enabling the TCR recipient to purchase the item. A TCR can be sent by a seller to any one of the following: a bidder, a best offer buyer, a member who has asked the seller a question, or any member with a postal code. This call can also be used to verify whether a new TCR can be created. Applies to the US eBay Motors site (except Parts and Accessories category).

Ends the listing specified by ItemID (if listed for at least 24 hours) and creates a new Transaction Confirmation Request (TCR) for an item, enabling the TCR recipient to purchase the item. This call can also be used to verify whether a new TCR can be created.

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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=LiveAuctions 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. A seller can 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). Only the seller who listed the item can perform these tasks. This call can be used anytime after a transaction has been created. However, it is recommended that you wait until the sale is complete before you use this call. <br><br> Applies to Half.com.

Enables a seller to do various tasks after processing a transaction. A seller can 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. 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. 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. CompleteSale No If included in the request, and with a value of ListingType = Half, indicates that the given ItemID and TransactionID values are for Half.com. ListingType is required input for Half.com items. CompleteSale Conditionally Half 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. <br><br> Applies to Half.com. 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 before the date and time at which it would normally end (per the listing duration). <br> For competitive-bidding listings that have bids on them, you must specify an EndingReason value. If you specify SellToHighBidder, the listing ends as a successful auction with winning bidder(s). Otherwise, all bids are cancelled before the item is ended. <br> There are two restrictions for ending items early in the last 12 hours of a listing. If there is a qualified bid (i.e., current high bid that, when applicable, meets the minimum reserve price) in the last 12 hours of a listing, the seller cannot end the item early. If the seller has cancelled a bid in the last 12 hours of the listing, the seller cannot end the item early. <br> Only the item's seller can use EndItem to end an 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).

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EndingItemsEarly 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. This can only be used to get the token only after the user gives consent for the token to be generated via the eBay signin page. After retrieval, the token can be used to authenticate other calls. This call must be authenticated using the username you created for use by your applications (not an authentication token).

Retrieves an authentication token for the user.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingATokenViaFetchToken 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 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 data 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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingAccountInformation 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 prospective buyer submitted.

Retrieve sales lead information for a real estate advertisement listing.

DetailLevel 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 No Filters the leads based on their status. GetAdFormatLeads No Boolean which indicates whether to return mail messages for this lead in a MemberMessage node. GetAdFormatLeads No Returns number of leads and contact and other information for each lead. One AdFormatLead node is returned for each lead. 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

DetailLevel: ReturnAll

Conditionally The total number of leads returned. Only returned if you do not specify a detail level. GetAdFormatLeads

DetailLevel: none

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

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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExtendingSecondChanceOffer detailed information on working with the result set http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MakingSecondChanceOffersForItems 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 Specifies whether return BiddingSummary container for each offer. GetAllBidders Conditionally 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 Reports how many calls your application has made and is allowed to make per hour or day.

Reports how many calls your application has made and is allowed to make per hour or day.

http://developer.ebay.com/support/certification Responds to a call to GetApiAccessRules. 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 who is creating a new listing. 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. <br> <br> See the eBay Web Services Guide for an overview of Item Specifics and details about the eBay attribute model.<br> <br> 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.

Retrieves an XML string that describes how to present Item Specifics to a seller who is creating a new listing. 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.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttributesAPI http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGACS http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrLWISCData A version of the Item Specifics definitions (attribute meta-data) 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 characteristic 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 characteristic set. AttributeSetIDs is an optional input. When IDs are specified, the call only returns meta-data for the corresponding characteristic sets. When no IDs are specified, the call returns all the current attribute 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

DetailLevel: none

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. Individual elements are not described in the eBay 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).<br> <br> Because this is returned as a string, the XML markup elements are escaped with character entity references (e.g., &amp;lt;eBay&amp;gt;&amp;lt;Attributes&amp;gt; ...). See the appendices in the eBay Web Services guide for general information about string data types. GetAttributesCS

DetailLevel: none, ReturnAll

Always http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrModel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DataTypes 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.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGAXSL http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrXSL 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<br> <br> 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

DetailLevel: none, ReturnAll

Always Retrieves the best offers associated with an ItemID according to the BestOfferStatus filter, where Active is the default value. Alternatively, specify a best offer ID to retrieve the details for a specific best offer.

Retrieves the best offers associated with an ItemID according to the BestOfferStatus filter, where Active is the default value. Alternatively, specify a best offer ID to retrieve the details for a specific best offer.

RespondToBestOffer 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 the user is currently bidding on, or has won or purchased. You can control the result set with elements such as ActiveItemsOnly, which limits the result set to active items.

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

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetBidderList GetSellerList 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. Yes GetBidderList No Response to a GetBidderList call, which retrieves all items the user is currently bidding on, or has won or purchased. 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 Retrieves information about an eBay Express shopping cart.

Retrieves information about an eBay Express shopping cart.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShoppingCarts Container for affiliate tags for the REST API and for the unified schema API. If you use affiliate tags, it is possible to get affiliate commissions based on calls made by your application. (See the <a href="http://affiliates.ebay.com/" target="_blank">eBay Affiliate Program</a> for information about commissions.) Affiliate tags enable the tracking of user activity. You can use child tags of AffiliateTrackingDetails if you want call output to include a string, in Item.ListingDetails.ViewItemURL, that includes affiliate tracking information. Affiliate details that you provide appear in the CheckoutURL that is returned by GetCart. Child elements of this element that are marked as conditionally required are required only if this container is present. GetCart No The ID of the shopping cart to inspect, obtained from a prior run of SetCart. GetCart Yes The country and postal code to which the items in the cart are to be shipped. Required only if you want shipping costs calculated for those items for which calculated shipping applies. Of no value if there are no items in the cart with calculated shipping. GetCart No The response to calling GetCart. Overall cart details. GetCart Always Retrieves the latest category hierarchy available on a given site. (By default, this is the site to which you submit the request.) You can retrieve all categories on the site, or you can use CategoryParent to retrieve one particular category and its subcategories.<br> <br> For each category, the call returns the category name, its unique ID (within the site to which you sent the request), and meta-data that helps you determine where the category fits in the hierarchy. eBay requires sellers to specify a category ID for most new listings. You can only list in leaf categories.<br> <br> The call also identifies a few eBay features that are only supported in some categories. For example, some categories support immediate payment (AutoPay), and some categories don't. For information about additional features that vary by category, use GetCategoryFeatures, GetCategory2FinanceOffer, and/or GetCategory2CS.<br> <br> The API provides other calls that supplement GetCategories. For example, consider using GetSuggestedCategories to help the seller choose a category ID. In certain cases, it may be helpful to use GetCategoryMappings to update locally stored item data (although most applications can use the simpler CategoryMappingAllowed flag in AddItem for this purpose). <p>Applicable to the <a href="http://developer.ebay.com/developercenter/rest/" target="_blank">REST API</a>.</p>

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

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryOverview GetCategory2CS, GetCategory2FinanceOffer, GetCategoryFeatures, GetCategoryMappings, GetSuggestedCategories 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. (Please do not pass a value of 0; zero (0) is an invalid value for CategoryParent.) 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 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, retrieves categories at all applicable levels. As with all calls, the actual data returned will vary depending on how you configure other fields in the request (including DetailLevel). GetCategories No 0 If false or omitted, retrieves only leaf categories. (You can only list in leaf categories.) If true, retrieves both leaf and internal (non-leaf) categories. 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

DetailLevel: ReturnAll

Always Indicates the number of categories returned (i.e., the number of CategoryType objects in CategoryArray). GetCategories

DetailLevel: ReturnAll

Always Indicates the last date and time that eBay modified the category hierarchy for the specified eBay site. GetCategories

DetailLevel: ReturnAll, none

Always Indicates the version of the category hierarchy on the specified eBay site. GetCategories

DetailLevel: ReturnAll, none

Always 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

DetailLevel: ReturnAll, none

Always 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

DetailLevel: ReturnAll, none

Always 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

DetailLevel: ReturnAll, none

Always 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 characteristic sets that are available for an eBay site.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGC2CS http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrLWAttributPD GetAttributesCS, GetCategories, GetProductFinder, GetProductSearchPage, GetProducts 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGC2CS 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.<br> <br> <span class="tablenote"><b>Note:</b> 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.</span> Contains data about categories that are mapped to characteristics sets. Use this data to determine:<br> - The names and IDs of the characteristics sets<br> - The availability of the Pre-filled Item Information feature for listings in that category (i.e., whether the category is catalog-enabled)<br> - For catalog-enabled categories, the available product search methods<br> - The current version information for the complete mapping<br> - The version information for each characteristics set GetCategory2CS

DetailLevel: ReturnAll

Conditionally http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGC2CS 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

DetailLevel: ReturnAll

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

DetailLevel: none, ReturnAll

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

DetailLevel: ReturnAll

Conditionally Retrieves the promotional financing offers available in a specified category. You can specify the date from which to retrieve financing offers.

Retrieves the promotional financing offers available in a specified category.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=OfferingFinanceOffers GetCategories 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

DetailLevel: none, ReturnAll

Always Set of finance offers that apply to the specified category. GetCategory2FinanceOffer

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

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryOverview GetCategories, GetCategory2FinanceOffer, GeteBayDetails Defines one category for which you want feature settings. If not specified, returns feature settings for all categories on the site. 10 GetCategoryFeatures No A level of depth in the category hierarchy. Retrieves all category nodes with a CategoryLevel less than or equal to the LevelLimit value. GetCategoryFeatures No Set this value to true to retrieve useful results. If true, retrieves all categories that override the site default settings. (If false or not specified, only retrieves data about leaf categories. If the details about overridden settings are only defined on a category's ancestor, the call does not return those settings if you only retrieve leaf categories.) GetCategoryFeatures Conditionally false Retrieves the specified feature setting for the site and for the category you specified in CategoryID, if any. If no feature IDs are specified, the call retrieves all feature settings. GetCategoryFeatures No Returns the current version of the set of feature meta-data. Compare this value to the version of the last version you downloaded to determine whether the data may have changed. GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Always Gives the time in GMT that the feature flags for the category hierarchy were last updated. GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Always A category whose feature settings override the prevailing settings in SiteDefaults. If you specified FeatureID in the request, only returns feature settings for those features. Only returned when the category overrides the site defaults. If the category has children and they aren't returned, the children inherit this category's feature settings. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Returns the feature settings defined for the entire site. All categories share these settings. However, some categories can override some settings, as indicated in the Category nodes (if any). GetCategoryFeatures

DetailLevel: ReturnAll

Always Returns definitions of the various features on the site, or the features you requested in FeatureID (if any). Each feature has a node within FeatureDefinitions. GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Always 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. <p>Applicable to the <a href="http://developer.ebay.com/developercenter/rest/" target="_blank">REST API</a>.</p>

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

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FindingListingsInCategory http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetCategoryListings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByCategoryID Restricts listings to return only items that have the Ad Format feature. If true, the values of ItemTypeFilter and StoreSearchFilter are ignored (if they are specified). That is, "AND" logic is not applied. GetCategoryListings No If true, only items with free shipping for the user's location are returned. The user's location is determined from the site ID specified in the request. If false, no filtering is done via this attribute. A listing is not considered a free shipping listing if it requires insurance or requires pick up or requires a shipping surcharge. false 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 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByListingType 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 When passed with a value of true, limits the results to Get It Fast listings. GetCategoryListings No Specifies items that accept a specific payment method or methods. GetCategoryListings No If true, each item in the result set can also include the item condition (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 is not returned if the seller only put the word "New" in the listing's title.) 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 The maximum number of related keywords to be retrieved. Use this field if you want the results to include recommended keywords (that is, keywords matching the category ID) in a RelatedSearchKeywordArray container. A value of 0 (the default) means no related search information is processed. 100 0 GetCategoryListings No You can group Best Match search results by category. To group by category, put the BestMatchCategoryGroup value in the OrderBy field. When you use the BestMatchCategoryGroup value, you can include group parameters in your call. Note that there will be significanty fewer results returned with a BestMatchCategoryGroup sort because the results account for Best Matches in lower-level (leaf) as well as higher-level categories. There is not a direct correlation between the number of results returned in a regular sort or the number of results returned with a BestMatch sort, and the results that are returned by the BestMatchCategoryGroup sort. You should not receive more than 2 pages of results with this type of sort. See also the new GroupCategoryID element in ItemType. 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 Container for keywords related to the category ID in the request. Can be returned if the request specified more than zero in the MaxRelatedSearchKeywords field. 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.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryMapping http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryMappingDetails http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategorySync GetCategories, GetCategory2CS, GetCategory2FinanceOffer, GetCategoryFeatures 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

DetailLevel: ReturnAll

Conditionally 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

DetailLevel: none, ReturnAll

Always Retrieves a botblock token and URLs for an image or audio clip that the user is to match. Use this in any process of yours for which you would find a botblock challenge to be of value. Process: (1) Call GetChallengeToken to get a token, an image URL and an audio clip URL. (2) Call ValidateChallengeInput with the token, the user's response, and whether the retrieved token should remain valid for a short period of time. The response from ValidateChallengeInput indicates whether the token is valid. <br><br> This is available for use by authorized third parties who are authorized to use <a href="io_PlaceOffer.html">PlaceOffer</a>.

Retrieves a botblock token and URLs for an image or audio clip that the user is to match.

ValidateChallengeInput Response to GetChallengeToken request. Botblock token that is used to validate that the user is a human and not a bot. GetChallengeToken Always The URL of the image your application should display to the user for a botblock challenge. GetChallengeToken Always The URL of the audio clip your application should provide for sight-impaired users. The audio clip corresponds to the image. GetChallengeToken Always 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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=IdentifyingListingsThatBenefitNonprofits 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 <b>The use of this call requires approval from the eBay Developers Program. If you would like access, please send an email to developer-relations@ebay.com detailing your typical usage, with estimated usage numbers for this call.</b> <br> <br> This call 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 SG and HK sites.

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

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 Retrieves a list of upsell or cross-sell items associated with the specifeid item ID. The seller must be the owner of an eBay Stores storefront to cross-promote items.

Retrieves a list of upsell or cross-sell items associated with the specifeid item ID.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CrossPromotionsChapter 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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UsingDescriptionTemplatesChapter 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 details of a dispute corresponding to the given dispute ID, any time after the dispute was opened and up to five years after it was closed. Can be used with Unpaid Item or Item Not Received disputes.

Requests the details of a dispute corresponding to the given dispute ID, any time after the dispute was opened and up to five years after it was closed.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemNotReceivedDisputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingDetailsAboutADispute 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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Feedback http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetFeedback DetailLevel Controls the pagination of the result set. Child elements, EntriesPerPage and PageNumber, 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). <br> Valid Pagination.EntriesPerPage input for GetFeedback is limited to 25, 50, 100, and 200. Other values will be treated as the closest valid input less than the value specified or 25. If a value of zero or less or a value greater than 200 is specified, the call fails with an error. When pagination is used and feedback detail entries are being returned, the summary data is returned after the last feedback detail entry on the last page of data. 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. 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

DetailLevel: ReturnAll

Conditionally Indicates the number of FeedbackDetailType objects returned in the FeedbackDetailArray property. Only applicable if feedback details are returned. GetFeedback

DetailLevel: ReturnAll

Conditionally 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

DetailLevel: none, ReturnAll

Conditionally Indicates the total feedback score for the user. GetFeedback

DetailLevel: none, ReturnAll

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

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=OfferingFinanceOffers 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. US, CA 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 that meet the criteria specified in the call request. If no finance offers exist that meet the request criteria, a count of 0 is returned. GetFinanceOffers

DetailLevel: none, ReturnAll

Always 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

DetailLevel: ReturnAll

Conditionally Retrieves a list of high bidders for the Dutch auction specified in the ItemId property of the request. A seller specifies a unique item ID in this call to determine which buyers are winning bidders and how many items each buyer can purchase.

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

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=LearningAboutBidders 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. <p>Applicable to the <a href="http://developer.ebay.com/developercenter/rest/" target="_blank">REST API</a>.</p>

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

DetailLevel half http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetItem 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 response should include detailed information relating to whether an item qualifies as an Express listing. eBay includes listings on eBay Express under conditions described in the eBay Web Services Guide. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressListingCriteria GetItem No Indicates if the caller wants to include watch count for that item in the response. You must be the seller of the item to retrieve the watch count. GetItem No Specifies whether or not to to include cross-promotion information for the item in the call response. <br><br> With a request version of 485 or higher, the default is false (do not include cross-promotion details). Set to true to retrieve cross-promotion information for the item. Cross-promotion information is returned in Item.CrossPromotion.PromotedItem.PromotionDetails. A promoted item will now contain multiple PromotionDetails containers. <br><br> With a request version lower than 485, the default is true (include cross-promotions). Set the value to false if you do not want to retrieve cross-promotion information. Cross-promotion information, PromotedPrice and PromotedPriceType, are returned in Item.CrossPromotion.PromotedItem. If a promoted item has multiple PromotedPriceType and PromotedPrice value pairs, only the last pair is returned. 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

DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

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

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=getItemRecommendations http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EngineRecs 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 Returns shipping cost estimates for an item, for a particular shipping service shipping to a specified postal code, for calculated shipping. 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). (Note that shipping insurance cost can only be determined once the final item price is known.) <p>Applicable to the <a href="http://developer.ebay.com/developercenter/rest/" target="_blank">REST API</a>.</p>

Returns shipping cost estimates for an item, for a particular shipping service shipping to a specified postal code, for calculated shipping. This is analogous to the Shipping Calculator seen in both the buyer and seller web pages.

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 Retrieves transaction information for a specified itemID. Depending on whether the listing sells one or multiple items and on whether anything has been sold in that listing, this returns zero, one or multiple transactions. Often, it is more efficient to use GetSellerTransactions instead.

Retrieves transaction information for a specified itemID. Depending on whether the listing sells one or multiple items and on whether anything has been sold in that listing, this returns zero, one or multiple transactions.

DetailLevel GetSellerTransactions, GetOrderTransactions 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RetrievingTransactionsForSingleItem 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 Whether to retrieve the order information. Default is false. 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

DetailLevel: none, ReturnAll, ItemReturnDescription

Always 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

DetailLevel: none, ReturnAll, ItemReturnDescription

Always 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

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Page number for the page of transactions the response returned. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always 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

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Item object that spawned the transaction. It is a purchase from this item's listing that the transaction represents. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always 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

DetailLevel: none, ReturnAll, ItemReturnDescription

Conditionally 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

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Returns transactions in which the user was involved and for which feedback is still needed from either the buyer or seller.

Returns items for which feedback needs to be left.

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 Response to GetItemsAwaitingFeedback. 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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=LiveAuctions 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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=LiveAuctions 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.

AddMemberMessagesAAQToBidder, AddMemberMessageAAQToPartner, AddMemberMessageRTQ http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers The ID of the item the message is about. <br><br> For ASQ messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included. ItemID is otherwise ignored. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetMemberMessages Conditionally 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. If specified, filters the returned messages to only those with a creation date greater than or equal to the specified date and time. <br><br> For CEM messages, StartCreationTime and EndCreationTime must be provided. <br><br> For ASQ messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included. GetMemberMessages Conditionally Used as end of date range filter. If specified, filters the returned messages to only those with a creation date less than or equal to the specified date and time. <br><br> For CEM messages, StartCreationTime and EndCreationTime must be provided. <br><br> For ASQ messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included. 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 An eBay ID that uniquely identifies a user. For GetMemberMessages, this is the sender of the message. If included in the request, returns only messages from the specified sender. 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 Returns a seller's Ask Seller a Question (ASQ) subjects, each in its own Subject node. If the seller has not customized the ASQ subjects using SetMessagePreferences, the call will return the current default values.

Returns a seller's Ask Seller a Question (ASQ) subjects.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetMessagePreferences SetMessagePreferences The ID of the user to retrieve ASQ subjects for. This value must be specified in the request, but does not need to be the same user as the user making the request. GetMessagePreferences Yes If true, indicates that the ASQ subjects for the specified user should be returned. GetMessagePreferences No Contains the ASQ subjects for the user specified in the request. Returns a seller's ASQ subjects, each in its own Subject node. If the seller has not customized the ASQ subjects using SetMessagePreferences, the call will return the current default values. Returned if IncludeASQPreferences = true was specified in the request. GetMessagePreferences Conditionally 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. <br /><br /> Note that this call requires a DetailLevel in the request. Omitting the Detail Level returns an error. <br /><br /> ItemID is not returned with this call. Use GetMemberMessages instead.

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

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetMyMessages DetailLevel 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 Used as beginning of date range filter. GetMyMessages No Used as end of date range filter. GetMyMessages Conditionally 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

DetailLevel: ReturnSummary

Conditionally 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

DetailLevel: ReturnHeaders, ReturnMessages

Conditionally 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

DetailLevel: ReturnHeaders, ReturnMessages

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. <br /> A DetailLevel of ReturnSummary returns only the BuyingSummary and the specific container requested. <br /> A DetailLevel of ReturnAll returns the BuyingSummary and all other containers. Any containers that were not specified in the request are returned with default settings.

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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=My_eBay http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetMyeBayBuying DetailLevel 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 This is an optional element, used to indicate whether the Bid Assistant feature is being used. GetMyeBayBuying No 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

DetailLevel: none, ReturnSummary, ReturnAll

Always Contains the items the user is watching. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains all the items the user has bid on. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains the items the user has placed best offers on. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains the items the user has bid on and won. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains the items the user has bid on and lost. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains a list of the user's favorite searches. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains a list of the user's favorite sellers. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains the list of second chance offers the user has received. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains the items that were bid on using the Bid Assistant feature. GetMyeBayBuying

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Requests reminder type totals from the user's MyeBay account.

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

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=My_eBay http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetMyeBayReminders 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. Contains the buying reminders in the user's My eBay account that match the request criteria. GetMyeBayReminders Conditionally 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. <br /> If you do not specify a detail level or a specific container, the response contains just the SellingSummary container. <br /> If you specify a container but not a detail level, the response contains SellingSummary and any container you specified in the request. <br /> If you specify a DetailLevel of ReturnAll, the response contains the SellingSummary and all other containers. Any containers that were not specified in the request are returned with default settings. <br /> While specifying pagination can help manage the amount of data that is returned (especially at ReturnAll), high-volume sellers may receive a warning message that the amount of data returned is over the system limit and therefore truncated.

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

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=My_eBay http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetMyeBaySelling DetailLevel 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. Contains summary information about the items the user is selling. GetMyeBaySelling

DetailLevel: none, ReturnSummary, ReturnAll

Always Contains the items the user has scheduled for sale, but whose listings have not yet started. GetMyeBaySelling

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains the items the user is selling that have active listings. GetMyeBaySelling

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains the items the user has sold. GetMyeBaySelling

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains the items whose listings have ended but that have not sold. GetMyeBaySelling

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains summary information about the items the user is selling. GetMyeBaySelling

DetailLevel: none, ReturnSummary, ReturnAll

Always Retrieves the requesting application's notification preferences. Details are only returned for events for which a preference was set at one point. For example, if you enabled notification for the EndOfAuction event and later disabled it, the GetNotificationPreferences response would cite the EndOfAuction event preference as Disabled. Otherwise, no details would be returned regarding EndOfAuction.

Retrieves the requesting application's notification preferences.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PlatformNotifications 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. Specifies application-based event preferences that have been enabled. GetNotificationPreferences Conditionally Specifies user-based event preferences that have been enabled or disabled. GetNotificationPreferences Conditionally return user data for notification settings such as set mobile phone number etc. GetNotificationPreferences Conditionally Characteristics or details of an event such as type, name and value. GetNotificationPreferences Conditionally Retrieves usage information about platform notifications for a given application. You can use this notification information to troubleshoot issues with platform notifications. You can call this up to 50 times per hour for a given application.

Retrieves usage information about platform notifications for a given application.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PlatformNotifications 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). If you have both orderIDs and itemIDs/transactionIDs, you may find this "combined call" more convenient than calling GetOrders and GetItemTransactions separately. Note that every transaction is nested within an Order node, even if the transaction does not belong to an order.

Retrieves information about one or more orders or one or more transactions (or both).

DetailLevel An array of ItemTransactionIDs. GetOrderTransactions Conditionally An array of OrderIDs. You can specify, at most, 20 OrderIDs. GetOrderTransactions Conditionally Response to GetOrderTransactions request. An array of Orders. GetOrderTransactions

DetailLevel: none, ItemReturnDescription, ReturnAll

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

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=WorkingWithCombinedPayment 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 (Active or Completed). To retrieve orders with a status of Inactive or Cancelled, you must specify the order IDs (OrderIDArray.OrderID). When you specify OrderIDArray.OrderID, no other filters are used. <br><br> For Half.com, you can get some, but not all orders. Orders on Half.com have different order status values from eBay orders. When you set ListingType to Half, set OrderStatus to Shipped. Otherwise, GetOrders may return incomplete information or have indeterminate results. GetOrders Active, Completed, Shipped Conditionally To retrieve Half.com orders, specify Half. To retrieve eBay orders, don't specify this field at all. (This field can't be used as a listing type filter on eBay.com. If not provided or if any value other than Half is specified, this field has no useful effect and the call retrieves eBay orders of all types. Also, you can't retrieve both eBay and Half.com orders in the same response.) GetOrders Half 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

DetailLevel: none

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

DetailLevel: none

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

DetailLevel: none

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

DetailLevel: none

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

DetailLevel: none

Always Applies only to Half.com. Indicates the total number of orders returned. GetOrders

DetailLevel: none

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.

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

PictureManagerDetailLevel: 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 sites: FR, HK, MY, PH, PL, SG, SE. Applicable to the <a href="http://developer.ebay.com/developercenter/rest/" target="_blank">REST API</a>.

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

FR, HK, MY, PH, PL, SG, SE 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.)<br> <br> 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.<br> <br> 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.<br> <br> 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). <br> <br> 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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPFM GetProductSearchResults, GetProductSellingPages 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPFM 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPFM 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 eBay Web Services 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.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPF http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFModel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFSearch GetProductFinderXSL, GetProductSearchResults, GetProductSellingPages, GetSearchResults 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPF 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

DetailLevel: none, ReturnAll

Conditionally 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).<br> <br> Because this is returned as a string, the XML markup is escaped with character entity references (e.g., &amp;lt;eBay&amp;gt;&amp;lt;ProductFinders&amp;gt;...). See the appendices in the eBay Web Services guide for general information about string data types. GetProductFinder

DetailLevel: ReturnAll

Conditionally http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPF http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFModel 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.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFXSL http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPFXSL GetProductFinderXSL, GetProductSearchResults The name of the XSL file to retrieve. If not specified, the call returns the latest versions of all available XSL files. Currently, this call only retrieves the product_finder.xsl file. FileName is an optional input. GetProductFinderXSL No The desired version of the XSL file. Required if FileName is specified. If not specified, the call returns the latest versions of all available XSL files that could be returned by the call. (Currently, this call only retrieves the product_finder.xsl file.) This is not a filter for retrieving changes to the XSL file. 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. In theory, multiple XSLFile objects can be returned. Currently, this call only retrieves the product_finder.xsl file. GetProductFinderXSL

DetailLevel: none, ReturnAll

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

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSrchP http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPSPSearch GetCategory2CS, GetProductSearchResults 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

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

DetailLevel: ReturnAll

Always http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSrchP 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.)<br> <br> 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.<br> <br> You can use this call to search for different products at the same time. That is, this call can perform batch searches.<br> <br> 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.<br> <br> 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.<br> <br> <b>GetProductSearchPage</b>: 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. <br> <br> <b>GetProductFinder</b>: 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. <br> <br> 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. <br> <br> 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. <br> <br> 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. <br> <br> 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). <br> <br> 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).

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductSearch http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSR GetProductSearchPage, GetProductFinder, GetProductFamilyMembers, GetProductSellingPages 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductSearch 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductSearch 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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSellP http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrModel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrLWISCData GetProductSearchResults, GetProductFamilyMembers, GetAttributesCS, AddItem 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:<br> <b>SYI</b> = 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.<br> <b>RYI</b> = 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.<br> <b>RELIST</b> = 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSellP 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. <br><br> 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. <br><br> 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. <br><br> See the Attribute Meta-Data Model section of the eBay Web Services guide for information about each element in the ProductSellingPagesData string. <br><br> Because the content is returned as a string, the XML markup elements are escaped with character entity references (e.g.,&amp;lt;eBay&amp;gt;&amp;lt;Attributes&amp;gt;...). See the appendices in the eBay Web Services guide for general information about string data types. GetProductSellingPages Always http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrModel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DataTypes Searches for stock information and reviews for certain kinds of products, such as a particular digital camera model. <p> GetProducts is designed to be useful to applications that support shopping comparison, product reviews, or basic supply and demand data. </p> <p> GetProducts also supports tracking so that members of the eBay Affiliates Program can get commissions for driving traffic to eBay. </p> <p class="tablenote"><b>Note:</b> For selling use cases, use GetProductSearchResults and GetProductSellingPages instead. </p> <p> To use this call, you typically pass in keywords, and GetProducts finds products with matching words in the product title, description, and/or Item Specifics. <p> For each product of interest, you call GetProducts again to retrieve additional details that would be useful to buyers: </p> <ul> <li>Top reviews of the product by eBay members, including part of the review text, plus links to the full text on the eBay Web site.</li> <li>Relevant buying guides (shopping advice) written by eBay members and by eBay staff, including part of the guide text, plus links to the full text on the eBay Web site.</li> <li>Up to 200 matching items on eBay (if any). (To find more matching items, use GetSearchResults.)</li> </ul> <p> <span class="tablenote"><b>Note:</b> As catalog queries can take longer than item queries, GetProducts can be slower than GetSearchResults. Also, due to the way product data is cached, you may get a faster response when you run the same query a second time.</span> <p>This call is applicable to the <a href="http://developer.ebay.com/developercenter/rest/" target="_blank">REST API</a>.</p> </p>

Searches for stock product information (Pre-filled Item Information), such as information about a particular DVD or camera. Also, retrieves top reviews, buying guides, and up to 200 listings associated with a product. Primarily useful for buying use cases.

GetSearchResults, GetCategories Contains the fields that form the search query. You can query against keywords, an eBay product reference ID (not to be confused with an eBay product ID), or external product ID (like an ISBN). GetProducts Yes Sorts the list of products returned. This is mostly only useful with QueryKeywords. (When you use ExternalProductID or ProductReferenceID, eBay usually only returns one product.) GetProducts No If true, the response includes items (if any) that match the product specified in ExternalProductID or ProductReferenceID. Not applicable with QueryKeywords. GetProducts No false If true, the response includes up to 20 reviews (if any) for the product specified in ExternalProductID or ProductReferenceID. The reviews are sorted by most helpful (most votes) first. When you include review details, please note that response times may be longer than 60 seconds. Not applicable with QueryKeywords. GetProducts No false If true, the response includes up to 5 buying guides (if any) for the product specified in ExternalProductID or ProductReferenceID. Not applicable with QueryKeywords. GetProducts No false If true, the response includes a histogram that lists the number of matching products found and the domains in which they were found. (A domain is like a high-level category.) Including the histogram can affect the call's performance. You may see significantly slower response times when many matching products are found. GetProducts No false Only applicable to developers who participate in the <a href="http://affiliates.ebay.com/" target="_blank">eBay Affiliate Program</a>. eBay uses the specified details to build a View Item URL string in the response that includes your affiliate tracking information in the correct format. When a user clicks through the URL to eBay and performs certain tasks, you may get a commission per the rules defined by the Affiliates Program. Only applicable when IncludeItemArray is specified (because the View Item URL is only returned in item information, not in product information). GetProducts No Returns stock product information in eBay catalogs, such as information about a particular DVD or camera. Optionally, also returns product reviews, buying guides, and items that match the product. A histogram that lists the number of matching products found and the domains in which they were found. A <i>domain</i> is essentially a set of categories that share certain common features (as determined by eBay). Each domain has its own name and ID. GetProducts Always The number of the page of data returned. If many products are found and multiple pages of results are available, use this in combination with ApproximatePages and HasMore to decide which page to retrieve next. As GetProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set EntriesPerPage to 1 in the request). 1 2000 GetProducts Always The total number of pages that can be returned, given the same query and filters in the request. As GetProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set EntriesPerPage to 1 in the request). 1 2000 GetProducts Always If true, more pages of results are available. That is, PageNumber is less than ApproximatePages. GetProducts Always The total number of matching products found. (If more than 2000 products are found, the call fails with an error.) 0 2000 GetProducts Always An eBay catalog product. This contains stock information about a particular DVD, camera, set of golf clubs, or other product. When you use QueryKeywords in the request, GetProducts returns a maximum of 20 products per page. When you use ExternalProductID or ProductReferenceID in the request, GetProducts usually only returns 1 product. (If more than one product matches the same ExternalProductID, GetProducts will return all of those products. As of the time of this writing, we expect this to be a rare case.) 20 GetProducts Always A list of items (if any) that match the product identified in ExternalProductID or ProductReferenceID in the request. Only returned when you set IncludeItemArray to true. The items are sorted by end time (ending soonest), and this order is not configurable in the request. Up to 200 items can be returned. All items are returned on the first page (page 1). Not returned when you use QueryKeywords.<br> <br> If ItemCount is greater than 200, use GetSearchResults if you want to retrieve more matching items.<br> <br> <span class="tablenote"><b>Note:</b> GetSearchResults doesn't currently support ProductReferenceID queries. So, you can use ExternalProductID (if present) as input to GetSearchResults. Otherwise, see Product.DetailsURL for a workaround to determine a ProductID value to use with GetSearchResults.</span> GetProducts Conditionally Contains information for up to 5 buying guides that match the query. Only returned when you set IncludeBuyingGuideDetails to true. Buying guides provide useful information about shopping in a particular domain, like Digital Cameras. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. If no buying guides are associated with the product, this only returns a link to the buying guide hub (the main Guides page). GetProducts Conditionally Retrieves all promotion rules associated with the specified item or store category.

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

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CrossPromotionsChapter The unique ID of the item for which to retrieve promotion rules. Mutually exclusive with StoreCategoryID. 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 to retrieve promotion rules. Mutually exclusive with ItemID. GetPromotionRules Conditionally The type of promotion. (CrossSell: items that are related to or useful in combination with this item. UpSell: items that are more expensive than or of higher quality than this item.) GetPromotionRules Yes Returns all promotion rules associated with the specified item or store category. An array of promotion rules associated with the item or store category specified in the request. GetPromotionRules Always Used to obtain information about promotional sales. If you do not specify a PromotionalSaleID, then GetPromotionalSaleDetails returns all promotional sales for the seller making the call. This call is part of the Promotional Price Display feature, which enables sellers to apply discounts across many listings. The feature applies only to Store Inventory and fixed-price listings.

Used to obtain information about promotional sales. This call is part of the Promotional Price Display feature, which enables sellers to apply discounts across many listings.

The ID of the promotional sale about which you want information. If you do not specify this field, then GetPromotionalSaleDetails returns all promotional sales for the seller making the call. GetPromotionalSaleDetails No Contains information about promotional sales. This call is part of the Promotional Price Display feature. Contains information about a promotional sale or sales. If you did not specify a PromotionalSaleID in the request, then all promotional sales for the seller are returned. Promotional sales enable sellers to add discounts to items. GetPromotionalSaleDetails Conditionally Returns an 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 needs the ebay userid/password you created for use by your applications (not an authentication token).

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

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SetupForAuthentication 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 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 needs the ebay userid/password you created for use by your applications (not an authentication token).

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

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SetupForAuthentication 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 Retrieves item listings based on keywords you specify. The keywords can include wildcards. <br> <br> 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. <br> <br> The call returns those item listings where the keywords appear in the title, subtitle, and (optionally) the description. Some input 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. <br> <br> 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). <br> <br> 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. <br> <br> 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. <br> <br> Use a DetailLevel value of ItemReturnAttributes (or ReturnAll) to return summary Item Specifics (only returned for categories that support summary Item Specifics in search results). <br><br>Not applicable to eBay Express or Half.com. Applicable to the <a href="http://developer.ebay.com/developercenter/rest/" target="_blank">REST API</a>.

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.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingItemsWithQuery http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetSearchResults http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchTypeDifferences DetailLevel 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByKeywords Limits the result set to items in the specified category. If no category ID is specified, all categories are searched by default.<br> <br> <span class="tablenote"><b>Note:</b> CategoryID does not control whether you will see the item's categories in the response. Set the value of DetailLevel to ItemReturnCategories to retrieve each item's primary category and secondary category (if any) in the response.</span><br> <br> If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. Here are a few ways to determine valid categories:<br> - Use the Categories input field to retrieve matching categories, and then submit the request again with one of those categories.<br> - Find items in all categories but set DetailLevel to ItemReturnCategories, determine the primary (or secondary) category ID for a similar item in the results, and then submit the request again with that category ID.<br> - Use another call like GetCategories or GetSuggestedCategories to find a valid category ID.<br> <br> 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 or ProductID. 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByCategoryID 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. 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 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. AllItems GetSearchResults No http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByListingType 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. This filter always causes item description text to be searched with the string specified in the Query field. That is, StoreSearchFilter forces the type of search that would have occurred if you had specified SearchInDescription in the SearchFlags field. 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PaginatingSearchResults 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.<br> <br> If you are searching for tickets, see TicketFinder instead. GetSearchResults No http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByItemSpecifics CallName.html#Request.TicketFinder 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByProductID 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingForMatchingCategories 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 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. If you specify Coarse, the call returns the fields shown in the <a href="#GranularityLevel">GranularityLevel table</a> plus any tags resulting from the detail level you specify. Controls the fields to return for each listing (not the set of listings that match the query). Yes 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), StoreExpansionArray (for items listed in the Store Inventory Format), 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 and StoreSearchFilter are ignored (if they are specified). That is, "AND" logic is not applied. GetSearchResults No If true, only items with free shipping for the user's location are returned. The user's location is determined from the site ID specified in the request. If false, no filtering is done via this attribute. A listing is not considered a free shipping listing if it requires insurance or requires pick up or requires a shipping surcharge. false 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 If true, each item in the result set can also include the item condition (e.g., New or Used) in the ItemSpecific property of the response. An item only includes the condition in the response if the seller filled in the Item Condition in the Item Specifics section of the listing. (That is, the condition is not returned if the seller only put the word "New" in the listing's title.) <br> <br> Controls the details to return for each listing (not the set of listings that match the query). <br> <br>To control whether to retrieve only new or used items, see ItemCondition (or SearchRequest). 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 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 The maximum number of related keywords to be retrieved. Use this field if you want the search results to include recommended keywords (that is, keywords matching one or more of the original keywords) in a RelatedSearchKeywordArray container. A value of 0 (the default) means no related search information is processed. 100 0 GetSearchResults No Container for affiliate tags. If you use affiliate tags, it is possible to get affiliate commissions based on calls made by your application. (See the <a href="http://affiliates.ebay.com/" target="_blank">eBay Affiliate Program</a> for information about commissions.) Affiliate tags enable the tracking of user activity. You can use child tags of AffiliateTrackingDetails if you want call output to include a string that includes affiliate tracking information. GetSearchResults No Limits the results to items with a minimum or maximum number of bids. You also can specify a bid range by specifying both a minimum and maximum number of bids in one call. GetSearchResults No Limits the results to new or used items, plus items that have no condition specified.<br> <br> Matches the new or used condition that the seller specified in the Item Specifics section of the listing. (That is, this won't specifically match on items where the seller only put the word "New" in the listing's title.)<br> <br> Only applicable to sites and categories that support a sitewide (global) item condition. For example, the US site does not currently support this. See GetCategory2CS. To search for the item condition on the US site, use a product finder instead (see SearchRequest). http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemCondition GetSearchResults.html#Request.SearchRequest GetSearchResults.html#Request.IncludeCondition GetSearchResults No Searches for event ticket listings only. If specified, this cannot be empty. For example, to search for all tickets (with no event, date, city, or quantity constraints), specify EventType with a value of Any. If specified, Query is optional. Query is useful when the user wants to search for a particular event name (like "eric clapton") or a venue that might be included in the listing title. If TicketFinder and SearchRequest are both specified in the same request, SearchRequest is ignored. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=TicketFinder GetSearchResults No You can group Best Match search results by category. To group by category, put the BestMatchCategoryGroup value in the Order field. When you use the BestMatchCategoryGroup value, you can include group parameters in your call. Note that there will be significanty fewer results returned with a BestMatchCategoryGroup sort because the results account for Best Matches in lower-level (leaf) as well as higher-level categories. There is not a direct correlation between the number of results returned in a regular sort or the number of results returned with a BestMatch sort, and the results that are returned by the BestMatchCategoryGroup sort. You should not receive more than 2 pages of results with this type of sort. See also the new GroupCategoryID element in ItemType. 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. <br><br> 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

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

GranularityLevel: Coarse

Conditionally Indicates the maximum number of items that can be returned in a SearchResultItemArray for any given call. GetSearchResults

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

GranularityLevel: Coarse

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

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

GranularityLevel: Coarse

Always Indicates whether there are more items, not yet returned, that match the search criteria. GetSearchResults

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

GranularityLevel: Coarse

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

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

GranularityLevel: Coarse

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

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

GranularityLevel: Coarse

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

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

Conditionally Contains items listed in the Store Inventory Format, if the request specifies that ExpandSearch is true. GetSearchResults

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

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 InternationalExpansionArray container for items, as well as other containers. The InternationalExpansionArray container contains items available from international sellers. GetSearchResults

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

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

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

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

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

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

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

Conditionally Container for keywords related to the original keywords in the request. Can be returned if the request specified more than zero in the MaxRelatedSearchKeywords field. GetSearchResults

DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none

Conditionally <b>Please check this <a href="https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=928">Knowledge Base article</a> for updates on current issues with GetSearchResultsExpress.</b><br> <br> 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.<br> <br> 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. <br> <br> Currently, this call is only supported for site ID 0 (Express US). <br> <br> The Sandbox does not support GetSearchResultsExpress.<br> <br> 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.<br> <br> <b>Item Results:</b> 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.<br> <br> <b>Catalog Product Results:</b> 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.<br> <br> <b>Histogram Results:</b> Instead of grouping items by category, the Express search engine groups items into <i>domains</i>. A domain is a set of items to which Express can apply a common set of search rules. Express supports three kinds of domains: <i>Product types</i>, <i>aisles</i>, and <i>departments</i>, 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.)<br> <br> 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).<br> <br> <span class="tablenote"><b>Note:</b> 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.</span> <br> <br> 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.<br> <br> See the eBay Web Services guide link below for more information about departments, aisles, and product types. </p> <p> 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.<br> <br> 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.<br> <br> <span class="tablenote"><b>Note:</b> 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).</span> <br> <br> <b>Search Tips:</b></p> <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> <p>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. </p> <p>Applicable to the <a href="http://developer.ebay.com/developercenter/rest/" target="_blank">REST API</a>.<br> <br> <b>Please check this <a href="https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=928">Knowledge Base article</a> for updates on current issues with GetSearchResultsExpress.</b><br> <br>

Please check this <a href="https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=928">Knowledge Base article</a> for updates on current issues with GetSearchResultsExpress.<br> <br> 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.

half http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressSearch http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=eBayExpress 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.<br> <br> 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.<br> <br> 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. <br> <br> 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.<br> <br> 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 (such as Books, DVDs and Movies, Music, and Video Games). ExternalProductIDType identifies which type of code you are searching for. If specified, also specify the ISBN or UPC code number in ExternalProductIDValue.<br> <br> 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 ISBN, UPC 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 basic details about the catalog product (returned in ProductArray) along with items (in ItemArray) that were listed with any version of the product.<br> <br> 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.<br> <br> <span class="tablenote"><b>Note:</b> This value is not the same as the ProductID used in AddItem and related calls. A ProductID represents a particular version of a catalog product, which is associated with a particular set of Item Specifics and other details. A ProductReferenceID is a more generic or global reference to a catalog product, which is useful for buy-side searching. One ProductReferenceID can be associated with multiple ProductIDs.</span><br> <br> 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.<br> <br> 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.<br> <br> 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. 200 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.<br> <br> 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.<br> <br> 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). 200 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.<br> <br> <b>Note:</b> Express product types are not eBay catalog products. This field does not support eBay catalog product names or IDs.<br> <br> 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.<br> <br> 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). 200 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.<br> <br> This option has no effect on how item or product results are sorted. Histogram, item, and product results are sorted independently.<br> <br> 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).<br> <br> Controls the way the data is organized in the response (not the details to return).<br> <br> This option has no effect on how histogram or product results are sorted. Histogram, item, and product results are sorted independently.<br> <br> 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).<br> <br> This option has no effect on how histogram or item results are sorted. Histogram, item, and product results are sorted independently.<br> <br> 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.<br> <br> 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.<br> <br> 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.<br> <br> 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.<br> <br> 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 .<br> <br> 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.<br> <br> Required if ItemSort is set to LowestTotalCost or HighestTotalCost (because the total cost calculation depends on the shipping cost calculation).<br> <br> 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.<br> <br> 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.<br> <br> 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.<br> <br> 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.<br> <br> 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 90 1 GetSearchResultsExpress No Container for affiliate tags for the REST API and for the unified schema API. If you use affiliate tags, it is possible to get affiliate commissions based on calls made by your application. (See the <a href="http://affiliates.ebay.com/" target="_blank">eBay Affiliate Program</a> for information about commissions.) Affiliate tags enable the tracking of user activity. You can use child tags of AffiliateTrackingDetails if you want call output to include a string, in ItemArray.Item.ListingDetails.ViewItemURL, that includes affiliate tracking information. For GetSearchResultsExpress, the ViewItemURL field is returned only if you specify AffiliateTrackingDetails in the request. 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.<br> <br> 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.<br> <br> 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.<br> <br> 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 originally requested (not the number of items or products that were returned). 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 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.

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.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=WorkingWithSellerEvents 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 StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified. If you do not specify the correspoding To filter, it is set to the time you make the call. For better results, the time period you use should be less than 48 hours. GetSellerEvents Conditionally Describes the latest (most recent) date to use in a date range filter based on item start time. If you specify the corresponding From filter, but you do not include StartTimeTo, t