# API: Get client orders

# getClientOrders

Get list of client's orders.

TIP

This API call uses pagination for results.

# Required parameters

Parameter Description
id Client ID

# Optional parameters

Parameter Description
page Which page to return
filter[number] Filter by order number
filterop[date_created] Filter by order date, possible values: =, <, >, !=
filter[date_created] Filter by order date, format: YYYY-MM-DD
filter[client_name] Filter by client name
filter[balance] Filter by order balance
filter[payment_module] Filter by payment module
filter[staff_member_id] Filter by staff member id

# Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=getClientOrders&id=ID

# PHP Samples

# Response

{
    "success": true,
    "orders": [
        {
            "id": "71",
            "date_created": "2011-12-09 03:26:29",
            "number": "2070437339",
            "total": "178.00",
            "status": "Active",
            "firstname": "Jack",
            "lastname": "Black",
            "module": "AlertPay",
            "client_id": "8",
            "invtotal": "178.00",
            "invstatus": "Paid",
            "currency_id": "0",
            "balance": "Completed"
        },
        {
            "id": "70",
            "date_created": "2011-12-07 00:31:31",
            "number": "104792403",
            "total": "295.00",
            "status": "Pending",
            "firstname": "Jack",
            "lastname": "Black",
            "module": "AlertPay",
            "client_id": "8",
            "invtotal": "295.00",
            "invstatus": "Unpaid",
            "currency_id": "0",
            "balance": "Incomplete"
        }
    ],
    "call": "getClientOrders",
    "server_time": 1323444240
}
Last Updated: 1/2/2024, 3:19:45 PM