Get orders
Get orders matching with the following parameters
Endpoint
| Method | URI |
|---|---|
| POST |
https://apiv2.keliweb.it/api/v2/keliweb/get-orders
|
Request Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
HTTP headers:
Authorization
|
string |
Bearer + the token to access APIs
|
Required |
limitstart
|
integer | The offset for the returned order data (default: 0) | Optional |
limitnum
|
integer | The number of records to return (default: 25) | Optional |
id
|
integer | Find orders for a specific id | Optional |
status
|
string | Find orders for a specific status | Optional |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
result
|
string | The result of the operation: success or error |
totalresults
|
integer | The total number of results available |
startnumber
|
integer | The starting number for the returned results |
numreturned
|
integer | The number of results returned |
orders
|
array | An array of orders matching the criteria passed |
Example Request (PHP Curl)
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://apiv2.keliweb.it/api/v2/keliweb/get-orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS =>
http_build_query(
array(
'id' => '1'
)
),
CURLOPT_HTTPHEADER => array(
"Content-Type: multipart/form-data",
"X-Requested-With: XMLHttpRequest",
"Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NhMmNlNkNjNhMmU2MmUxIzZDRkODY5MS1mMDMzLTQ1MWMtYjU-3EHc",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Example Request (jQuery AJAX)
var form = new FormData();
form.append("id", "1");
var settings = {
"async": true,
"crossDomain": true,
"url": "https://apiv2.keliweb.it/api/v2/keliweb/get-orders",
"method": "POST",
"headers": {
"Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImNjMDEwYWVlYmUzMjMxMmZlZjBiNzRjYTBhMmNlNDc2MjNjNhMMTA1MzJjODk1In0",
"cache-control": "no-cache",
},
"processData": false,
"contentType": false,
"mimeType": "multipart/form-data",
"data": form
}
$.ajax(settings).done(function (response) {
console.log(response);
});
Example Response (JSON payload)
{
"result" : "success",
"totalresults" : "1",
"startnumber" : "0",
"numreturned" : "1",
"orders[order][0][id]" : "1",
"orders[order][0][ordernum]" : "8549045538",
"orders[order][0][userid]" : "1",
"orders[order][0][contactid]" : "0",
"orders[order][0][date]" : "2016-01-01 17:02:40",
"orders[order][0][nameservers]" : "",
"orders[order][0][transfersecret]" : "",
"orders[order][0][renewals]" : "",
"orders[order][0][promocode]" : "",
"orders[order][0][promotype]" : "",
"orders[order][0][promovalue]" : "",
"orders[order][0][orderdata]" : "a:0:}",
"orders[order][0][amount]" : "15.95",
"orders[order][0][paymentmethod]" : "paypal",
"orders[order][0][invoiceid]" : "1",
"orders[order][0][status]" : "Active",
"orders[order][0][ipaddress]" : "",
"orders[order][0][fraudmodule]" : "",
"orders[order][0][fraudoutput]" : "",
"orders[order][0][notes]" : "",
"orders[order][0][paymentmethodname]" : "PayPal",
"orders[order][0][paymentstatus]" : "Unpaid",
"orders[order][0][name]" : "Test Client",
"orders[order][0][currencyprefix]" : "$",
"orders[order][0][currencysuffix]" : " USD",
"orders[order][0][frauddata]" : "",
"orders[order][0][lineitems][lineitem][0][type]" : "product",
"orders[order][0][lineitems][lineitem][0][relid]" : "1",
"orders[order][0][lineitems][lineitem][0][producttype]" : "Other Product\/Service",
"orders[order][0][lineitems][lineitem][0][product]" : "SSL Certificates - Rapid SSL",
"orders[order][0][lineitems][lineitem][0][domain] " : ">",
"orders[order][0][lineitems][lineitem][0][billingcycle]": "Monthly",
"orders[order][0][lineitems][lineitem][0][amount]" : "$15.95 USD",
"orders[order][0][lineitems][lineitem][0][status]" : "Active"
}