Filtering
You can filter results returned from the API using a standard URI format.
Supported operators
Not all supported operators work with all endpoint attributes. Each endpoint provides a list of filter attributes. Filtering on custom data fields (Flows) is not supported.
You can only filter on base object attributes. Filtering through non-base attributes will not work as expected, and will return everything.
There is a maximum of 10 filters allowed on a single request.
Operator | Description |
| Equals |
| Like |
| Greater than |
| Greater than or equal to |
| Less than |
| Less than or equal to |
Passing an incorrectly formatted filter or using an unsupported operator will return a 400
response with the following error:
Supported characters
As filters are passed as URL query string parameters, we must ensure all filters are URL safe and are strict about the characters that can be used in a filter.
Characters | Can be used in filter? |
| Yes |
| Yes |
| Yes |
| Yes (an unencoded |
| Only when URL encoded ( |
Passing unsupported characters will return a 400
response with the following error:
URL encoding filters
We recommend URL encoding filters before sending them to Moltin. For ease of use, you can encode the full filter, so filter=eq(email,ron+1@swanson.com)
would become filter=eq%28email%2Cron%2B1%40swanson.com%29
.
Supported endpoints
/brands
/categories
/collections
/customers
/files
/orders
/products
For more detail on filtering, see the Filtering section under each endpoint.
Last updated