Getting started
Filtering & paging
List endpoints (orders, products) accept the same grammar.
Filter
filter=field||operator||value
Repeat filter= to combine conditions (AND):
curl "https://elmatajer.com/api/v1/vendor/orders?filter=status_type||eq||1&filter=grand_total||gte||500" -H "Api-Key: YOUR_API_KEY"
| Operator | Meaning | Example |
|---|---|---|
eq |
equal | filter=status_type||eq||3 |
ne |
not equal | filter=qty||ne||0 |
gt / lt |
greater / less than | filter=price||gt||100 |
gte / lte |
greater / less or equal | filter=created_at||gte||2026-11-01 |
$in |
one of (comma list) | filter=id||$in||12,15,19 |
cont |
contains | filter=name||cont||shirt |
isnull / notnull |
empty / not empty | filter=sku||notnull |
Fields you can filter and sort on:
- Orders:
id,order_number,status_type,payment_status,payment_type,grand_total,customer_name,mobile,email,created_at,updated_at - Products:
id,name,sku,price,qty,is_available,category_id,has_variants,created_at,updated_at
An unknown field or operator answers 422 with the allowed list.
Sort, limit, page, fields
| Parameter | Example | Notes |
|---|---|---|
sort |
sort=price,DESC |
ASC or DESC |
limit |
limit=50 |
1–100, default 20 |
page |
page=2 |
starts at 1; meta.last_page tells you when to stop |
fields |
fields=order_number,totals |
top-level response keys to keep (id always stays) |
"meta": { "current_page": 1, "last_page": 7, "per_page": 20, "total": 131, "has_more": true }