diff --git a/src/guides/v2.3/rest/performing-searches.md b/src/guides/v2.3/rest/performing-searches.md index 2f787b5c130..017f7153c06 100644 --- a/src/guides/v2.3/rest/performing-searches.md +++ b/src/guides/v2.3/rest/performing-searches.md @@ -21,9 +21,9 @@ where: Condition | Notes --- | --- -`eq` | Equals. +`eq` | Equals `finset` | A value within a set of values -`from` | The beginning of a range. Must be used with `to` +`from` | The beginning of a range. Must be used with `to`. `gt` | Greater than `gteq` | Greater than or equal `in` | In. The `value` can contain a comma-separated list of values. @@ -32,11 +32,11 @@ Condition | Notes `lteq` | Less than or equal `moreq` | More or equal `neq` | Not equal -`nfinset` | A value that is not within a set of values +`nfinset` | A value that is not within a set of values. `nin` | Not in. The `value` can contain a comma-separated list of values. `notnull` | Not null `null` | Null -`to` | The end of a range. Must be used with `from` +`to` | The end of a range. Must be used with `from`. {:.bs-callout-info} `condition_type` is optional if the operator is `eq`. @@ -93,6 +93,18 @@ searchCriteria[filter_groups][0][filters][0][value]=2016-07-01 00:00:00& searchCriteria[filter_groups][0][filters][0][condition_type]=gt ``` +## Simple search using an `in` conditions type + +The following search finds all the products that are provided in the value field. When you specify the `in` condition type, the value field must be a comma separated list. + +```http +GET /rest//V1/products? +searchCriteria[filter_groups][0][filters][0][field]=entity_id& +searchCriteria[filter_groups][0][filters][0][value]=1,2,3,4,5& +searchCriteria[filter_groups][0][filters][0][condition_type]=in +``` +The query returns 5 items. + ### Logical OR search The following example searches for all products whose names contain the string `Leggings` or `Parachute`. The instances of `%25` in the example are converted into the SQL wildcard character `%`.