recommendationItemIds
Note: This initial version of the Listing Recommendation API is not available for testing in the Sandbox environment. |
This call returns a list of the seller's items that have one or more listing recommendations of a specific type (listing recommendation type is used as an inclusive filter in the request). Because the list of items that are retrieved can be very large based on the seller's selling activity, this call is implemented with a pagination filter that allows the seller to retrieve one page of data (Item IDs) per call. Once the seller has retrieved all items that have listing recommendations of a certain type, they can then start running itemRecommendations calls using the corresponding Item ID and recommendationType values.
Output Samples Change History |
recommendationItemIds Input
The seller's X-EBAY-GLOBAL-ID value is an optional HTTPS header for this call. Examples of this string value include 'EBAY-US' or 'EBAY-UK'. If this header is not specified, it defaults to 'EBAY-US'.
An example of a recommendationItemIds HTTPS request (with all possible parameters) is shown below. To learn more about an individual parameter and its possible values, click its name in the sample call (or scroll down to find it in the table).
See also Samples.
https://svcs.ebay.com/services/selling/listingrecommendation/v1/item/recommendationItemIds?recommendationType=FnF&pageNumber=1&entriesPerPage=10
Parameter | Type | Occurrence | Meaning |
---|
Call-Specific Query Parameters  |
Input Samples Change History |
recommendationItemIds Output
The XML sample response in the box below lists all parameters that might be returned in the response. To learn more about an individual parameter and its possible values, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
<?xml version="1.0" encoding="utf-8"?> <recommendationItemIdsResponse xmlns="http://www.ebay.com/marketplace/listing/v1/service"> <!-- Call-Specific Output Fields --> <items> <itemId>string</itemId> <!-- ... more itemId fields possible here ... --> </items> <pagination> <entriesPerPage>int</entriesPerPage> <pageNumber>int</pageNumber> <totalEntries>int</totalEntries> <totalPages>int</totalPages> </pagination> <!-- (No Standard Output fields) --> </recommendationItemIdsResponse>
Return Value | Type | Occurrence | Meaning |
---|
Call-Specific Output Fields  |
(No Standard Output fields) |
Input Output Change History |
recommendationItemIds Samples
This call retrieves the eBay Item IDs of listings that have one or more listing recommendations of a specific type.
Description
The following call retrieves all eBay Item IDs of listings that have 'Picture' listing recommendations. The pagination parameters are also set in the call.
Input
The recommendationIds HTTPS GET call will retrieve all of the seller's listings (identified by eBay Item ID) that have one or more 'Picture' listing recommendations. To retrieve the listings with 'Picture' listing recommendations, the seller passes in the value of 'Picture' in the recommendationType parameter. The pageNumber value is set to '1', which means that the first page of results will be returned, and the entriesPerPage value is '5', which means that as many as five Item IDs will appear on each page of results.
https://svcs.ebay.com/services/selling/listingrecommendation/v1/item/recommendationItemIds?recommendationType=Picture&pageNumber=1&entriesPerPage=5
Output
In the response below, five eBay Item IDs are returned. This indicates that these five items all have one or more 'Picture' listing recommendations. The next move for the seller might be to make an itemRecommendations call for each of these items.
The pagination container in the response consists of fields that indicate the total number of pages and items that match the input criteria, the number of items per page (which was set with the entriesPerPage parameter in the request), and the current page number being viewed (which was set with the pageNumber parameter in the request). As you can see from the values in the pagination container, there is actually a total of 16 items with 'Picture' listing recommendations and four pages of results. To view all four pages of items, the seller would have to make three more additional recommendationItemIds calls, while incrementing the pageNumber value by 1 for each subsequent call.
{ "items": [ 280598875472, 200875600012, 280598904529, 200875609522, 290879280649 ], "pagination": { "pageNumber": 1, "entriesPerPage": 5, "totalPages": 4, "totalEntries": 16 } }
recommendationItemIds Change History
Version | Description |
---|---|
1.0.0 2015-07-10 |
|
1.0.0 2013-04-12 |
|