Searching
- Marcus Gesing
Owned by Marcus Gesing
Mar 18, 2017
1 min read
Loading data...
The endpoint for searching products is Search. It's an OData action and only accessible through the POST method.
Example
POST http://localhost:1260/odata/v1/Products/Search?q=notebook
The API expect the same query string parameters used for searching in the shop frontend. The following table shows query string parameters that can be used for searching products.
| Parameter | 500px|Explanation |
|---|---|
| q | Search term. |
| i | Page index. |
| s | Page size. |
| o | Order by. ProductSortingEnum value. |
| p | Price range (from-to || from(-) || -to). |
| c | Category identifiers. |
| m | Manufacturer identifiers. |
| r | Minimum rating. Value from 1 to 5. |
| a | Product availability by stock. |
| n | New arrivals. |
| d | Delivery time identifiers. |
| * | Variants & attributes. Mega Search Plus plugin required. |
| v | View mode. Has no relevance for the API. |
Paging
Paging parameter $top and $skip are ignored. Instead use the above query string parameters for page index and page size. The maximum page size is determined by the same configuration setting that is used for all other API requests. Its default value is 120.