Pagination & ordering
All list endpoints support pagination and sorting via URL query parameters.
Query parameters
| Parameter | Type | Required | Default | Notes |
|---|---|---|---|---|
page | integer | No | 0 | Zero-indexed. First page is 0. |
size | integer | No | 200 | Number of items per page. Maximum 1000; values above this are capped (or rejected — see Errors). |
sortField | string | No | — | Name of the field to sort by. See individual endpoint docs for supported fields. |
sortDirection | string | No | ASC | One of ASC or DESC. |
Example requests
Default pagination (page 0, size 200):
GET /v0/items
Second page, 50 per page:
GET /v0/items?page=1&size=50
Sorted by creation date, newest first:
GET /v2/saleorders?sortField=createdAt&sortDirection=DESC
Combined:
GET /v2/saleorders?page=2&size=100&sortField=createdAt&sortDirection=DESC
Errors
sizegreater than1000will be ignored and1000will be used.- Invalid
sortField(not a recognized field for the endpoint) returns a400 Bad Request. sortDirectionvalues other thanASC/DESCwill be ignored anASCwill be used.
Updated 2 months ago
Did this page help you?
