negotiation APIv1.1.0

findEligibleItems

GET
/find_eligible_items
This method evaluates a seller's current listings and returns the set of IDs that are eligible for a seller-initiated discount offer to a buyer.

A listing ID is returned only when one or more buyers have shown an "interest" in the listing.

If any buyers have shown interest in a listing, the seller can initiate a "negotiation" with them by calling sendOfferToInterestedBuyers, which sends all interested buyers a message that offers the listing at a discount.

For details about how to create seller offers to buyers, see Sending offers to buyers.

Input

Resource URI (production)

GET https://api.ebay.com/sell/negotiation/v1/find_eligible_items?

URI parameters

ParameterTypeDescription
limitintegerThis query parameter specifies the maximum number of items to return from the result set on a page in the paginated response.

Minimum: 1    Maximum: 200
Default: 10

Occurrence: Optional

offsetintegerThis query parameter specifies the number of results to skip in the result set before returning the first result in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 results from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set.

Default: 0

Occurrence: Optional

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringThe eBay marketplace on which you want to search for eligible listings.

For a complete list of supported marketplaces, see Negotiation API requirements and restrictions.

Occurrence: Required

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.inventory.readonly

https://api.ebay.com/oauth/api_scope/sell.inventory

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
eligibleItemsarray of EligibleItemA list of items that are eligible for a seller-initiated offer to a buyer.

Each element in the list contains the listing ID of a listed item. These IDs represent the listings for which buyers have shown an interest.

Occurrence: Always

eligibleItems.listingIdstringThe unique eBay-assigned ID for an eBay listing.

A listingId is assigned by eBay when a seller creates a listing with the Trading API.

Occurrence: Always

hrefstringThe URI of the current page of results from the result set.

Occurrence: Always

limitintegerThe number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter.

Occurrence: Always

nextstringThe URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set.

Max length: 2048

Occurrence: Conditional

offsetintegerThe number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.

Occurrence: Always

prevstringThe URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set.

Max length: 2048

Occurrence: Conditional

totalintegerThe total number of items retrieved in the result set.

If no items match the search criteria, the server returns the HTTP status code
204 No Content.

Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
204No Content
400Bad Request
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
150000API_NEGOTIATIONAPPLICATIONInternal error. Please try the call again after a minute or two. If the error persists, contact eBay developer support for assistance.
150001API_NEGOTIATIONREQUESTMandatory headers are missing.
150002API_NEGOTIATIONREQUESTThe marketplace value {marketplaceId} is not supported. The supported values are: {marketplaceIds}
150003API_NEGOTIATIONREQUESTInvalid limit. Limit should be between {minLimit} and {maxLimit}.
150004API_NEGOTIATIONREQUESTInvalid offset. Offset cannot be less than 0.

Warnings

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Retrieve the seller's listing IDs for which buyers have shown an interest

This sample shows how to retrieve all the seller's listing IDs which have "interested" buyers.

Buyers are considered to have shown an interest in a listing if, for example, they put a Watch on the listing or add the listing to their shopping cart (then later abandon the cart).

Input

This method does not use a request payload. Simply set the X-EBAY-C-MARKETPLACE-ID header and make the call using the method's endpoint, as shown in the sample.
GET
https://api.ebay.com/sell/negotiation/v1/find_eligible_items?limit=10

Output

If the call is successful, it returns a response payload similar to the one shown below.

All listing IDs that have interested buyers are gathered into a "result set" and the result set is paginated and returned according to the offset and limit query parameters specified in the request.