Open API v2 / Get started / Filtering, sorting & pagination

Filtering, sorting & pagination

List endpoints share a common set of query parameters for narrowing, ordering, and paging through results.

Pagination

Use Offset and Limit. Offset skips items (default 0); Limit caps the page size (default 100). The response's TotalItemsCount tells you how many match in total.

Query
GET /api/v2/admin/categories?Offset=100&Limit=50

Sorting

Set Order_By to a field name. Prefix with - for descending, and comma-separate for tie-breakers.

Query
GET /api/v2/admin/categories?Order_By=Weight,-Name

Filtering with Where

Pass a JSON filter in the Where parameter. Combine field operators with the logical operators $and / $or.

$eq · $not_eqEquals / does not equal.
$contains · $not_containsSubstring match.
$in · $not_inValue is (not) in a list.
$gt · $gte · $lt · $lteNumeric / date comparisons.
$starts · $endsStarts / ends with.
Examples
GET /api/v2/admin/categories?Where={"$contains":{"Name":"shoes"}}

GET /api/v2/admin/orders?Where={"$and":[{"$gt":{"Id":0}},{"$lt":{"Id":100}}]}
i

Some endpoints also accept Semantic_Query (natural-language search ranked by relevance) with an optional Min_Score threshold.