Filtering
Filter and paginate product data from the Export API.
There are different ways in which the exported data can be filtered: no filter, simple filtering, and advanced filtering. When sending no filter parameters, all products are shown. Simple filtering allows searching for one or more values in a specific column. Advanced filtering allows the creation of filters that can be compared with complex queries.
For a better illustration, you can see some example SQL queries equivalent to what the API requests throughout the documentation. In those examples, you can expect the schema of your exported data to look as follows:
CREATE TABLE IF NOT EXISTS `data` (
`id` TEXT,
`color` text DEFAULT '',
`name` text DEFAULT '',
`email` text DEFAULT '',
`countryCode` text DEFAULT ''
);Keep in mind that the returned attributes and query-able columns depend on individual client data schema.
No Filter
Retrieve all products without any filter parameters.
Pagination
Paginate over the full product set using limit and offset.
Group By
Return unique values for a column using the groupBy parameter.
Simple Filter
Filter results by one or more values for a single column.
Advanced Filter
Build complex multi-criteria filters with operators, ordering, and more.
How is this guide?