Documentation

[ertugrulkaya]

Hi ,

Could you please add an example or documentation about how use advancedFilter logic??

[ertugrulkaya]

if you want you can show me with in 30 min, then i can prepare document for you.

then you can upload it into web page. @iammukeshm

[parthvnp]

@iammukeshm I can work on adding an example to documentation.

[ertugrulkaya]

Any update?

[parthvnp]

@ertugrulkaya Will have it ready by tomorrow.

[parthvnp]

@ertugrulkaya Here is a simple example with AdvancedFilter logic. We will apply this logic to api/v1/products/export endpoint as this is one of the endpoint that accepts advancedFilter argument in post request body. First, create a product using api/v1/products. Ensure that the brandId you pass to the request body exists in the database table Catalog.Brands. Suppose you named this new Product Cool Product and would like to search for the Product using it's name instead of it's Id. Then you would pass the following advancedFilter query in the post request to api/v1/products/export to export an Excel Sheet containing this product (if it exists in the database).

{
  "advancedFilter": {
    "field": "Name",
    "operator": "eq",
    "value": "Cool Product"
  },
  "brandId": "<replace with brand id you used to create the product>"
}

Similarly, you can pass other variants of advanced filter by combining various operators with values for a field. The supported operators are :

public static class FilterOperator
{
    public const string EQ = "eq";
    public const string NEQ = "neq";
    public const string LT = "lt";
    public const string LTE = "lte";
    public const string GT = "gt";
    public const string GTE = "gte";
    public const string STARTSWITH = "startswith";
    public const string ENDSWITH = "endswith";
    public const string CONTAINS = "contains";
}

Note that FilterOperator's use is restricted to field that support the operator. For instance, the startswith operator cannot be combined with a numeric value. If you want any more examples, please let me know.

[learnwithkawsar]

Hello @parthvnp
What about other properties in base-filter like logic ,filters . can you please give a multiple-column searching using advancedFilter.

"advancedFilter": {
"logic": "string",
"filters": [
"string"
],
"field": "string",
"operator": "string",
"value": "string"
},