API: List affiliate commissions

getAffiliateCommissions

List affiliate commissions

TIP

This API call uses pagination for results.

Required parameters

Parameter	Description
id	Affiliate ID

Optional parameters

Parameter	Description
filter[id]	Filter by order ID
filter[number]	Filter by order number
filter[aff_id]	Filter by affiliate ID
filter[lastname]	Filter by affiliate lastname
filter[client_id]	Filter by customer ID
filter[c_lastname]	Filter by customer lastname
filter[date_created]	Date created filter value
filter[paid]	Filter by paid status
filter[total]	Filter by total amount
filter[commission]	Filter by commission amount
filter[description]	Filter by description

Request

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

PHP Samples

Response

{
    "success": true,
    "orders": [
        {
            "id": "116",
            "aff_id": "1",
            "client_id": "402",
            "order_id": "9577",
            "invoice_id": "0",
            "type": "order",
            "commission": "0.98",
            "paid": "0",
            "datepaid": "0000-00-00 00:00:00",
            "date_created": "2023-01-12 02:08:23",
            "description": "",
            "firstname": "Franco",
            "lastname": "Kortak Baldede",
            "companyname": "Wehner, Welch and Sipes",
            "invoice_status": "",
            "order_status": "Fraud"
        },
        {
            "id": "92",
            "aff_id": "1",
            "client_id": "409",
            "order_id": "9531",
            "invoice_id": "0",
            "type": "order",
            "commission": "0.19",
            "paid": "0",
            "datepaid": "0000-00-00 00:00:00",
            "date_created": "2022-10-27 05:21:53",
            "description": "",
            "firstname": "[email protected]",
            "lastname": "[email protected]",
            "companyname": "",
            "invoice_status": "",
            "order_status": "Active"
        },
        {
            "id": "91",
            "aff_id": "1",
            "client_id": "398",
            "order_id": "9484",
            "invoice_id": "0",
            "type": "order",
            "commission": "0.80",
            "paid": "1",
            "datepaid": "2022-11-11 06:35:04",
            "date_created": "2022-09-12 06:30:26",
            "description": "",
            "firstname": "Jaclyn",
            "lastname": "Harris",
            "companyname": "",
            "invoice_status": "",
            "order_status": "Pending"
        }
    ],
    "call": "getAffiliateCommissions",
    "sorter": {
        "perpage": 25,
        "totalpages": 1,
        "sorterrecords": 3,
        "sorterpage": 1
    },
    "server_time": 1684239412
}