Elmatajer · API docs
Orders

List orders

Newest first, 20 a page. Accepts filters, sort, limit, page and fields.

GEThttps://elmatajer.com/api/v1/vendor/orders
Permission: orders.read

Query parameters

NameTypeRequiredDescription
statusintegerNoLifecycle type 1–6 (see Order statuses).
qstringNoSearch order number, customer name or phone.

Request

curl "https://elmatajer.com/api/v1/vendor/orders?filter=status_type||eq||1&sort=created_at,DESC&limit=10" \
  -H "Api-Key: YOUR_API_KEY" \
  -H "Accept: application/json"

Response 200

{
    "status": "ok",
    "data": [
        {
            "id": 4904,
            "order_number": "IOY539",
            "status": 1,
            "status_type": 1,
            "status_label": "Under review",
            "payment_status": 1,
            "payment_type": 1,
            "order_type": 1,
            "customer": {
                "name": "Mona Adel",
                "email": "mona@example.com",
                "mobile": "+201012345678"
            },
            "address": {
                "line": "12 Tahrir St, Dokki",
                "building": "Building 4, flat 2",
                "landmark": "Next to the pharmacy"
            },
            "totals": {
                "sub_total": 120,
                "delivery_charge": 30,
                "discount_amount": 0,
                "tips": 0,
                "grand_total": 150,
                "currency": "EGP",
                "currency_code": "EGP"
            },
            "items_count": 1,
            "items": [
                {
                    "id": 3038,
                    "item_id": 22511,
                    "name": "Building blocks set",
                    "image": "https://cdn.elmatajer.com/…/blocks.webp",
                    "sku": "BLK-01",
                    "qty": 1,
                    "price": 120,
                    "variant": null,
                    "extras": null,
                    "line_total": 120
                }
            ],
            "notes": null,
            "created_at": "2026-11-03T18:00:16+02:00"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 13,
        "per_page": 10,
        "total": 127,
        "has_more": true
    }
}