API:getOrders - Get orders

Get list of orders.

Optional parameters

page

Which page to return

list

Status of orders to list, possible values: all, active, pending, fraud, cancelled

Request

GET http://url_to_your_hostbill.com/admin/api.php?api_id=API_ID&api_key=API_KEY&call=getOrders

<?php
   include 'class.hbwrapper.php';
   HBWrapper::setAPI('http://url_to_hb.com/admin/api.php','API ID','API Key');
   $return = HBWrapper::singleton()->getOrders();
   print_r($return);
?>

<?php
   $url = 'http://url_to_hb.com/admin/api.php';
   $post = array(
      'api_id' => API_ID,
      'api_key' => API_Key,
      'call' => 'getOrders',
   );
   $ch = curl_init();
   curl_setopt($ch, CURLOPT_URL, $url);
   curl_setopt($ch, CURLOPT_POST, 1);
   curl_setopt($ch, CURLOPT_TIMEOUT, 30);
   curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
   curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
   curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
   curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
   $data = curl_exec($ch);
   curl_close($ch);
  
   $return = json_decode($data, true);
   print_r($return);
?>

<?php
   /* Use this method to access HostBill api from HostBill modules */
   $api = new ApiWrapper();
   $return = $api->getOrders();
   print_r($return);
?>

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"
         },
         {
            "id": "66",
            "date_created": "2011-11-22 23:35:41",
            "number": "565063300",
            "total": "11.94",
            "status": "Active",
            "firstname": "John",
            "lastname": "Doe",
            "module": null,
            "client_id": "1",
            "invtotal": null,
            "invstatus": null,
            "currency_id": "0",
            "balance": "Completed"
         },
         {
            "id": "65",
            "date_created": "2011-11-22 02:33:13",
            "number": "69052095",
            "total": "11.94",
            "status": "Active",
            "firstname": "Mike",
            "lastname": "Blue",
            "module": null,
            "client_id": "6",
            "invtotal": "11.94",
            "invstatus": "Unpaid",
            "currency_id": "0",
            "balance": "Incomplete"
         },
         {
            "id": "61",
            "date_created": "2011-11-18 03:36:39",
            "number": "586068641",
            "total": "12.95",
            "status": "Pending",
            "firstname": "Random",
            "lastname": "Customer",
            "module": "PostFinance DirectLink",
            "client_id": "2",
            "invtotal": null,
            "invstatus": null,
            "currency_id": "0",
            "balance": "Completed"
         },
         {
            "id": "27",
            "date_created": "2011-10-28 06:18:43",
            "number": "1430574390",
            "total": "0.00",
            "status": "Pending",
            "firstname": "Jonah",
            "lastname": "Hamon",
            "module": null,
            "client_id": "4",
            "invtotal": null,
            "invstatus": null,
            "currency_id": "0",
            "balance": "Completed"
         },
         {
            "id": "18",
            "date_created": "2011-10-26 06:59:51",
            "number": "1351549576",
            "total": "0.00",
            "status": "Pending",
            "firstname": "Random",
            "lastname": "Customer",
            "module": "PayPal",
            "client_id": "2",
            "invtotal": null,
            "invstatus": null,
            "currency_id": "0",
            "balance": "Completed"
         },
         {
            "id": "8",
            "date_created": "2011-10-14 07:11:54",
            "number": "1722491866",
            "total": "0.00",
            "status": "Active",
            "firstname": "John",
            "lastname": "Doe",
            "module": null,
            "client_id": "1",
            "invtotal": null,
            "invstatus": null,
            "currency_id": "0",
            "balance": "Completed"
         },
         {
            "id": "6",
            "date_created": "2011-10-08 05:02:51",
            "number": "147763791",
            "total": "0.00",
            "status": "Active",
            "firstname": "Random",
            "lastname": "Customer",
            "module": null,
            "client_id": "2",
            "invtotal": null,
            "invstatus": null,
            "currency_id": "0",
            "balance": "Completed"
         },
         {
            "id": "4",
            "date_created": "2011-10-07 00:09:53",
            "number": "1533074516",
            "total": "0.00",
            "status": "Active",
            "firstname": "John",
            "lastname": "Doe",
            "module": null,
            "client_id": "1",
            "invtotal": null,
            "invstatus": null,
            "currency_id": "0",
            "balance": "Completed"
         }
      ],
      "call": "getOrders",
      "server_time": 1323445273
   }