Chilkat Online Tools

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

Back to Collection Items

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    Integer iItemId
    String sName
    Integer iPrice
    String sDescription
    Integer iOrderId
    String sArrivalDate
    String sOrderDate
    Integer iOrderTotal
    String sAddress
    Integer i
    Integer iCount_i
    String sTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://api.simplekart.com/orders/:orderId" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

    // 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

    Get ComIntOf Of hoJResp "orderId" To iOrderId
    Get ComStringOf Of hoJResp "arrivalDate" To sArrivalDate
    Get ComStringOf Of hoJResp "orderDate" To sOrderDate
    Get ComIntOf Of hoJResp "orderTotal" To iOrderTotal
    Get ComStringOf Of hoJResp "address" To sAddress
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "items" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComIntOf Of hoJResp "items[i].itemId" To iItemId
        Get ComStringOf Of hoJResp "items[i].name" To sName
        Get ComIntOf Of hoJResp "items[i].price" To iPrice
        Get ComStringOf Of hoJResp "items[i].description" To sDescription
        Move (i + 1) To i
    Loop



End_Procedure

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}"
    }
  ]
}