orders.list
orders.list
orders.list
Description
Retrieve orders list
Input Parameters
Name | Type | Required | Description |
---|---|---|---|
order_id | mixed (int|array) | no | Show results with specified order ID(s) |
item_id | mixed (int|array) Item ID(s) | no | related to order |
page | (int) | no | Show only results on specified page |
limit | (int) | no | Restrict results per page |
on_date | (string) | no | Show results occured on specified date |
from_date | (string) | no | Show results from specified date |
to_date | (string) | no | Show results until specidied date |
from_id | (int) Show results with ID(s) | no | higher than specified |
to_id | (int) Show results with ID(s) | no | lower than specified |
nocache | (bool) | no | Choose whether results should be cached or not |
tracking_tag | mixed (int|array) | no | Show results with specified client side tracking tag(s) |
tracking_order | mixed (int|array) | no | Show results with specified client side order ID(s) |
currency | mixed (string|array) | no | Show results with specified currency |
tracking_user | mixed (int|array) | no | Show results with specified client side user ID(s) |
status | mixed (string|array) | no | Show results with specified order status |
country | mixed (string|array) | no | Show results having specified countries |
ip | mixed (string|array) | no | Show only results having specified IP address(es) |
host | mixed (string|array) | no | Show only results having specified host name(s) |
pp_type | mixed (string|array) | no | Show results having specified processor type(s) |
name | (string*) | no | Show results having specified user name |
ccnum | (string*) | no | Show results having specified credit card number |
exclude | (array) | no | Excluded orders id(s) |
Return
Return
Name | Type | Description |
---|---|---|
result | array | result with data |
Usage Example
<?php require_once "curl_http_client/src/CurlHttpClient.php"; $curl = new \Dinke\CurlHttpClient; //setup payment url and timeout $payment_url = 'https://dev-payment.datingvip.com/api.json'; $timeout = 30; $curl->setCredentials('some-token', 'some-pass'); $post_data = array( 'cmd' => 'orders.list', 'data' => array('limit' => 1) ); $response = $curl->sendPostData($payment_url, $post_data, null, $timeout); if($response === false) { //handle errors } //decode json to get array $response = json_decode($response, true); var_dump($response);
Excepted output after running this script should be:
array (size=1) 'result' => array (size=8) 'code' => int 700 'status' => string 'Action completed succesfully' (length=28) 'command' => string 'orders.list' (length=11) 'result' => array (size=1) 0 => array (size=37) 'order_id' => string '565' (length=3) 'ptnr_id' => string '55' (length=2) 'user_id' => string '455' (length=3) 'pp_id' => string '6' (length=1) 'ppac_id' => string '109' (length=3) 'force_mid' => string '' (length=0) 'ccdt_id' => string '0' (length=1) 'tracking_order' => string '0' (length=1) 'tracking_tag' => string '14' (length=2) 'first_name' => string 'Dragan' (length=6) 'last_name' => string 'Dinic' (length=5) 'street' => string '' (length=0) 'city' => string '' (length=0) 'state' => string '' (length=0) 'zipcode' => string '34000' (length=5) 'country' => string 'US' (length=2) 'email' => string 'dragan@dinke.net' (length=16) 'ip' => string '127.0.0.1' (length=9) 'host' => string 'whatever.dinke.net' (length=18) 'currency' => string 'USD' (length=3) 'hash' => string '1429542388626afa413c7f8651385ee2' (length=32) 'rebill_transaction_id' => string '0' (length=1) 'order_status' => string 'failed' (length=6) 'ts' => string '1429542524' (length=10) 'type' => string 'basic' (length=5) 'step_down' => string '0' (length=1) 'tax_rate' => string '0.00' (length=4) 'tax_amount' => string '0.00' (length=4) 'u_email' => string 'dragan@dinke.net' (length=16) 'tracking_user' => string '1' (length=1) 'pay_user_id' => string '455' (length=3) 'p_name' => string 'Dating Backend' (length=14) 'processor' => string 'RG' (length=2) 'items' => array (size=1) 0 => string '20564' (length=5) 'name' => string 'Dating Backend' (length=14) 'upgrade_retry' => string '0' (length=1) 'upgrade_retry_plan' => string '' (length=0) 'request' => array (size=4) 'cmd' => string 'orders.list' (length=11) 'data' => array (size=1) 'limit' => string '1' (length=1) 'token' => string 'some-token' (length=26) 'pass' => string 'some-pass' (length=32) 'ts' => int 1429557997 'origin_ip' => string '93.87.220.184' (length=13) 'errors' => null
Referenced Files
None
Subscribers
None
- Last Author
- aplawecki
- Last Edited
- Mar 16 2021, 09:10