Chilkat Online Tools

phpAx / SimpleKart E-commerce API / Get order details from database

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://api.simplekart.com/orders/:orderId',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "orderId": 674,
//   "items": [
//     {
//       "itemId": 1657,
//       "name": "Smart WiFi Router",
//       "price": 2096,
//       "description": "Wifi router/wireless router. One of routers for wireless internet, wireless routers for home. Dual band router and gigabit router. Ideal as internet router also gaming router. Long range coverage with high speed. Compatible with all 802.11ac devices and below. 5ghz router/5g router Frequency Range: 2.4GHz and 5GHz; Interface Available: 4 x 10/100/1000Mbps LAN Ports, 1 10/100/1000Mbps WAN Port, 1 USB 2.0 Ports; Protocols Supported: Supports IPv4 and IPv6; System Requirement: Microsoft Windows 98SE NT 2000 XP Vista, or Windows 7 Windows 8/8.1/10, MAC OS NetWare UNIX or Linux; Wireless Standards: IEEE 802.11ac/n/a 5GHz, IEEE 802.11b/g/n 2.4GH"
//     }
//   ],
//   "arrivalDate": "2020-3-04T13:07:45.962Z",
//   "orderDate": "2020-03-06T19:27:26.733Z",
//   "orderTotal": 2096,
//   "address": "95 Tarkiln Hill St.Laurel, MD 20707"
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$orderId = $jResp->IntOf('orderId');
$arrivalDate = $jResp->stringOf('arrivalDate');
$orderDate = $jResp->stringOf('orderDate');
$orderTotal = $jResp->IntOf('orderTotal');
$address = $jResp->stringOf('address');
$i = 0;
$count_i = $jResp->SizeOfArray('items');
while ($i < $count_i) {
    $jResp->I = $i;
    $itemId = $jResp->IntOf('items[i].itemId');
    $name = $jResp->stringOf('items[i].name');
    $price = $jResp->IntOf('items[i].price');
    $description = $jResp->stringOf('items[i].description');
    $i = $i + 1;
}


?>

Curl Command

curl -X GET
https://api.simplekart.com/orders/:orderId

Postman Collection Item JSON

{
  "name": "Get order details from database",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/orders/:orderId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "orders",
        ":orderId"
      ],
      "variable": [
        {
          "key": "orderId",
          "value": "674",
          "type": "string",
          "description": "(Required) "
        }
      ]
    },
    "description": "Obtain item details from the database"
  },
  "response": [
    {
      "name": "OK - Successfully obtained order details",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/orders/:orderId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            ":orderId"
          ],
          "variable": [
            {
              "key": "orderId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"orderId\": 674,\n \"items\": [\n  {\n   \"itemId\": 1657,\n   \"name\": \"Smart WiFi Router\",\n   \"price\": 2096,\n   \"description\": \"Wifi router/wireless router. One of routers for wireless internet, wireless routers for home. Dual band router and gigabit router. Ideal as internet router also gaming router. Long range coverage with high speed. Compatible with all 802.11ac devices and below. 5ghz router/5g router Frequency Range: 2.4GHz and 5GHz; Interface Available: 4 x 10/100/1000Mbps LAN Ports, 1 10/100/1000Mbps WAN Port, 1 USB 2.0 Ports; Protocols Supported: Supports IPv4 and IPv6; System Requirement: Microsoft Windows 98SE NT 2000 XP Vista, or Windows 7 Windows 8/8.1/10, MAC OS NetWare UNIX or Linux; Wireless Standards: IEEE 802.11ac/n/a 5GHz, IEEE 802.11b/g/n 2.4GH\"\n  }\n ],\n \"arrivalDate\": \"2020-3-04T13:07:45.962Z\",\n \"orderDate\": \"2020-03-06T19:27:26.733Z\",\n \"orderTotal\": 2096,\n \"address\": \"95 Tarkiln Hill St.Laurel, MD 20707\"\n}"
    },
    {
      "name": "Bad Request - Invalid order ID supplied",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/orders/:orderId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            ":orderId"
          ],
          "variable": [
            {
              "key": "orderId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"error\": {\n  \"message\": \"Provided Id is invalid\"\n }\n}"
    },
    {
      "name": "Not Found - Order not found",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/orders/:orderId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            ":orderId"
          ],
          "variable": [
            {
              "key": "orderId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"error\": {\n  \"message\": \"The order you are looking for, does not exist\"\n }\n}"
    }
  ]
}