Retrieve a list of order statuses and related counts
| Parameter | Type | Description | Required |
|---|---|---|---|
| action | string | "GetOrderStatuses" | Required |
| Parameter | Type | Description |
|---|---|---|
| result | string | The result of the operation: success or error |
| totalresults | int | The total number of results available |
| statuses | array | An array of order statuses |
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
http_build_query(
array(
'action' => 'GetOrderStatuses',
// See https://developers.whmcs.com/api/authentication
'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
'password' => 'SECRET_OR_HASHED_PASSWORD',
'responsetype' => 'json',
)
)
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);$command = 'GetOrderStatuses';
$postData = array(
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later
$results = localAPI($command, $postData, $adminUsername);
print_r($results);{
"result": "success",
"totalresults": 4,
"statuses": {
"status": [
{
"title": "Pending",
"count": 1
},
{
"title": "Active",
"count": 15
},
{
"title": "Fraud",
"count": 0
},
{
"title": "Cancelled",
"count": 1
}
]
}
}| Version | Changelog |
|---|---|
| 1.0 | Initial Version |