get https://api.shioja.com/searchProducts
Search for any product of your choice
The search Product endpoint is used to find a specific product while returning a short product description.
A proper use case is for finding a specific product eg L.G televisions.
Request
{{baseUrl}}/searchProducts
| Parameters | Type | Description | Optional |
|---|---|---|---|
| query | string | This is where you enter the name of the product you want to search for. | required* |
| sortBy | string | This is how you want the products results to be sorted. It can be any one of price, brand, category, department, family, name. The default value is price. | optional |
| sortAscending | bool | This is where you arrange your sorted products sequentially. Set it as true if ascending and false if descending. It defaults to ascending | optional |
| multiFilter | string | This is the multi-filter that you intend to use in your product query. It is either category, brand, family or department. | optional |
| lowerPriceRange | int | This is where you input the lower price range of the products that you want to display to your users. It takes an integer in Naira.. | optional |
| UpperPriceRange | int | This is where you input the upper price range of the products that you want to display to your users. It takes an integer in Naira.. | optional |
| familyFilter | Array | This is where you specify the family of products that you to show to your users. It must be an array of just one string if it is not a multi-filter. A multi-filter will have an array of two or more strings. | optional |
| brandFilter | Array | This is where you specify the brand of products that you to show to your users. It must be an array of just one string if it is not a multi-filter. A multi-filter will have an array of two or more strings. | optional |
| categoryFilter | Array | This is where you specify the category of products that you to show to your users. It must be an array of just one string if it is not a multi-filter. A multi-filter will have an array of two or more strings. | optional |
| departmentFilter | Array | This is where you specify the department of products that you to show to your users. It must be an array of just one string if it is not a multi-filter. A multi-filter will have an array of two or more strings. | optional |
| numberOfProductsPerPage | int | The number of products per page. This defaults to 10 if you provide no value. | optional |