sort=price)Returned items are sorted based on their total cost (i.e., price + shipping cost).
Items with the lowest combined price are shown first.
When sorting by price, it is highly recommended that:
- The
X-EBAY-C-ENDUSERCTXrequest header is used, and - The
contextualLocationparameter specifies the delivery country and postal code.
These values must be URL-encoded.
X-EBAY-C-ENDUSERCTX: contextualLocation=country%3DUS%2Czip%3D19406Descending price order
To sort items from highest price to lowest price insert a minus sign (-) before
price as the search criterion:sort=-price
sort=distance)Returned items are sorted based on their distance from the buyer's location.
Items that are closest to the buyer are listed first.
Important! When sorting by distance, all required pickup filters must be included in the request.
Items can be sorted by date based on:
- Listing date (
sort=newlyListed)
Returned items are sorted based on their listing date.
Newly listed items are shown first. - End date (
sort=endingSoonest)
Returned items are sorted based on the date/time on which their listing is scheduled to end.
Items that are closest to their scheduled ending date/time are shown first.
Note: Only listings where
FIXED_PRICE (Buy It Now) is a buying option are returned by default. To retrieve listings that do not have FIXED_PRICE as a buying option, the buyingOptions filter can be used to retriev"
},
{
"info": {
"name": "searchByImage",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.ebay.com{basePath}/item_summary/search_by_image",
"headers": [
{
"name": "X-EBAY-C-ENDUSERCTX",
"value": ""
},
{
"name": "X-EBAY-C-MARKETPLACE-ID",
"value": ""
},
{
"name": "Content-Type",
"value": ""
},
{
"name": "Accept-Language",
"value": ""
}
],
"params": [
{
"name": "aspect_filter",
"value": "",
"type": "query",
"description": "This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red.Note: The category ID must be specified twice:
- Once as a URI parameter in the
category_idsfield - Once as part of the
aspect_filterfield
For example, to return items for a woman's red shirt, issue the following request:
/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}To get a list of the aspect pairs and the category, which is returned in the dominantCategoryId field, set fieldgroups to ASPECT_REFINEMENTS as illustrated here:/buy/browse/v1/item_summary/search?q=shirt&fieldgroups=ASPECT_REFINEMENTSNote: The pipe symbol is used as a delimiter between aspect filter values. If a value contains a pipe symbol (for example, the brand name 'Bed|Stü'), you must enter a backslash before the pipe character to prevent it from being evaluated as a delimiter.
The following example illustrates the correct format for entering two brand names as aspect filter values, one of which contains a pipe symbol:
/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed\|Stü|Nike} For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter"
},
{
"name": "category_ids",
"value": "",
"type": "query",
"description": "The category ID is used to limit the results that are returned. This field may pass in one category ID or a comma separated list of IDs as illustrated in the following examples:/buy/browse/v1/item_summary/searchByImage?category_ids=29792
/buy/browse/v1/item_summary/searchByImage?category_ids=267,29792Note: Currently, you can pass in only one category ID per request.
To refine the set of information that is returned,
category_ids may be combined with other available filters.Because the list of eBay category IDs is not published and category IDs are not the same across all eBay marketplaces, category IDs may be determined by:
- Visiting the Category Changes page
- Using the Taxonomy API. Refer to Get Categories for Buy APIs for complete information.
- Issuing the following call to retrieve the
dominantCategoryIdfor an item:/buy/browse/v1/item_summary/searchByImage?q= keyword&fieldgroups=ASPECT_REFINEMENTS
Note:
charity_ids is only supported by the US and UK marketplaces.Charity ID is a charity's unique identification number:
- In the US, this is the Employer Identification Number (EIN).
- In the UK, this is the Charity Registration Number (CRN), commonly called Charity Number.
charity_ids may be retrieved/determined as follows:- Search for a supported charity using the Charity API's getCharityOrgs method.
Important! The value to be passed in as
charity_idsis that returned in theregistrationIdfield. - Search for a supported charity by visiting Charity Search. Click on the charity's name to display its information. The EIN number is included in the charity's information block at the top of the page.
For example, the charity ID for American Red Cross, is530196605.
charity_ids may be specified in each query. Additionally, charity_ids may be combined with category_ids and/or q keyword values to further filter returned results.A sample query using
charity_ids is:/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469" }, { "name": "fieldgroups", "value": "", "type": "query", "description": "A comma-separated list of values that controls what is returned in the response. The default is
MATCHING_ITEMS, which returns the items that match the keyword or category specified. The other values return data that can be used to create histograms or provide additional information.Valid Values:
ASPECT_REFINEMENTS
This field group adds the aspectDistributions container to the response.
Note: Information returned byASPECT_REFINEMENTSis category specific.BUYING_OPTION_REFINEMENTS
This field group adds the buyingOptionDistributions container to the response.CATEGORY_REFINEMENTS
This field group adds the categoryDistributions container to the response.CONDITION_REFINEMENTS
This field group adds the conditionDistributions containers, such asNEW,USED, etc., to the response. Within these groups are multiple states of the condition.
For example,NEWcan be New without tag, New in box, New without box, etc.EXTENDED
This field group adds the following fields to the response:MATCHING_ITEMS(default value)
This field group is intended to be used with one or more of the refinement values listed above. This is used to return the specified refinements and all matching items.FULL
This field group returns all refinement containers and all matching items.
MATCHING_ITEMS"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "An array of field filters that can be used to limit/customize the result set.Refer to Buy API Field Filters for the information about available filters.
For example, to filter shirts based on a specific range of prices, include the filter illustrated here:
/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50]Filters may also be combined within a single request as illustrated in the sample below which further refines results to return only those shirts available from specific sellers:
/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50],sellers:{rpseller|bigSal}Note: Refer to Buy API Field Filters for additional information and examples of all supported filters. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:FilterField"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The number of items from the result set returned in a single page.Note: If a value is set in the
limit field, the value of offset must be either zero or a multiple of the limit value. An error is returned for invalid offset values.Note: This method can return a maximum of 10,000 items in one results set.
Min: 1
Max: 200
Default: 50" }, { "name": "offset", "value": "", "type": "query", "description": "Specifies the number of items to skip in the result set. This is used with the
limit field to control the pagination of the output.For example:
- If
offsetis 0 andlimitis 10, the method will retrieve items 1-10 from the list of items returned - If
offsetis 10 andlimitis 10, the method will retrieve items 11-20 from the list of items returned.
offset must be either zero or a multiple of the value set in the limit field. An error is returned for invalid offset values.Note: This method can return a maximum of 10,000 items in one results set.
Min: 0
Max: 9,999
Default: 0" }, { "name": "sort", "value": "", "type": "query", "description": "Note: This call currently returns results in a best-match order. This query parameter presently has no practical use. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:SortField" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Note:
![\"Experimental](\"/cms/img/docs/experimental-icon.svg\" "\\"Experimental"){kind=icon}
This is an experimental method that is available to select developers approved by business units. For information about how to obtain access to this API in production, refer to the Buy APIs Req"
}
]
}
],
"bundled": true
}