Chilkat Online Tools

C++ / New FreshBooks / Single Item

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

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

    CkHttp http;
    bool success;

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/{{itemId}}",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

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

    // {
    //   "response": {
    //     "result": {
    //       "item": {
    //         "accounting_systemid": "wkMd2g",
    //         "description": "Just a touring pack",
    //         "id": 59726,
    //         "inventory": "4",
    //         "itemid": 59726,
    //         "name": "Touring Pack",
    //         "qty": "10",
    //         "tax1": 0,
    //         "tax2": 0,
    //         "unit_cost": {
    //           "amount": "550.00",
    //           "code": "USD"
    //         },
    //         "updated": "2019-04-19 08:38:19",
    //         "vis_state": 0
    //       }
    //     }
    //   }
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *Accounting_systemid = jResp.stringOf("response.result.item.accounting_systemid");
    const char *Description = jResp.stringOf("response.result.item.description");
    int Id = jResp.IntOf("response.result.item.id");
    const char *Inventory = jResp.stringOf("response.result.item.inventory");
    int Itemid = jResp.IntOf("response.result.item.itemid");
    const char *Name = jResp.stringOf("response.result.item.name");
    const char *Qty = jResp.stringOf("response.result.item.qty");
    int Tax1 = jResp.IntOf("response.result.item.tax1");
    int Tax2 = jResp.IntOf("response.result.item.tax2");
    const char *Amount = jResp.stringOf("response.result.item.unit_cost.amount");
    const char *Code = jResp.stringOf("response.result.item.unit_cost.code");
    const char *Updated = jResp.stringOf("response.result.item.updated");
    int Vis_state = jResp.IntOf("response.result.item.vis_state");
    }

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/{{itemId}}

Postman Collection Item JSON

{
  "name": "Single Item",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "let jsonData = JSON.parse(responseBody);",
          "pm.environment.set(\"itemId\", jsonData.response.result.item.id);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/{{itemId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "items",
        "items",
        "{{itemId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Single Item",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/{{itemId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "items",
            "items",
            "{{itemId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNRVNeEVwKFlUPGk4IFAQcA1IAWQVYCldcAgZYUVoBCxxJUE4VBA8CBlRXUFoDAFUCBwAAXhoYVFIJSgRs"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:18:58 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Date",
          "value": "Wed, 24 Apr 2019 18:18:58 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17369-MDW"
        },
        {
          "key": "X-Cache",
          "value": "MISS"
        },
        {
          "key": "X-Cache-Hits",
          "value": "0"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"result\": {\n            \"item\": {\n                \"accounting_systemid\": \"wkMd2g\",\n                \"description\": \"Just a touring pack\",\n                \"id\": 59726,\n                \"inventory\": \"4\",\n                \"itemid\": 59726,\n                \"name\": \"Touring Pack\",\n                \"qty\": \"10\",\n                \"tax1\": 0,\n                \"tax2\": 0,\n                \"unit_cost\": {\n                    \"amount\": \"550.00\",\n                    \"code\": \"USD\"\n                },\n                \"updated\": \"2019-04-19 08:38:19\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    },
    {
      "name": "Single Item w/ added SKU",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/303664",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "items",
            "items",
            "303664"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNRVNeEVwKFlUPGk4IFAQcAlEAVAhTAlRVBwBZU1sACwdITFMbEw9WBwgGVlVUBQQHBAtTCVoWHlUEVRJUPA=="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "500"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "499"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1561052088"
        },
        {
          "key": "Retry-After",
          "value": "60"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Wed, 20 Jun 2018 17:33:47 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Date",
          "value": "Thu, 20 Jun 2019 17:33:47 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17355-MDW"
        },
        {
          "key": "X-Cache",
          "value": "MISS"
        },
        {
          "key": "X-Cache-Hits",
          "value": "0"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"result\": {\n            \"item\": {\n                \"accounting_systemid\": \"E86Qp\",\n                \"description\": \"AirTV\",\n                \"id\": 303664,\n                \"inventory\": null,\n                \"itemid\": 303664,\n                \"name\": \"1 Month Subscription\",\n                \"qty\": \"0\",\n                \"sku\": null,\n                \"tax1\": 0,\n                \"tax2\": 0,\n                \"unit_cost\": {\n                    \"amount\": \"75.00\",\n                    \"code\": \"CAD\"\n                },\n                \"updated\": \"2019-01-16 11:52:08\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    },
    {
      "name": "Single Item w/ SKU",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/{{itemId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "items",
            "items",
            "{{itemId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNRVNeEVwKFlUPGk4IFAQcAl0IVgdRAFNVBwVXUVMACghITFMbEwEFAAADBVIAUFYGUV1WDFsWHlUEVRJUPA=="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "500"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "499"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1561053195"
        },
        {
          "key": "Retry-After",
          "value": "60"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Wed, 20 Jun 2018 17:52:14 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Date",
          "value": "Thu, 20 Jun 2019 17:52:14 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17369-MDW"
        },
        {
          "key": "X-Cache",
          "value": "MISS"
        },
        {
          "key": "X-Cache-Hits",
          "value": "0"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"result\": {\n            \"item\": {\n                \"accounting_systemid\": \"wkMd2g\",\n                \"description\": \"Just a touring pack\",\n                \"id\": 59724,\n                \"inventory\": \"4\",\n                \"itemid\": 59724,\n                \"name\": \"Alan Touring Pack\",\n                \"qty\": \"10\",\n                \"sku\": \"SDK2919361221\",\n                \"tax1\": 0,\n                \"tax2\": 0,\n                \"unit_cost\": {\n                    \"amount\": \"550.00\",\n                    \"code\": \"USD\"\n                },\n                \"updated\": \"2019-06-20 13:50:24\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    },
    {
      "name": "Single Item",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/{{itemId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "items",
            "items",
            "{{itemId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNRVNeEVwKFlUPGk4IFAQcAVULUgFUA1VcAwdXUlUBBANITFMbE1ZUAlVTA1tXW1tSUg0BWgEWHlUEVRJUPA=="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "500"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "499"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1561053382"
        },
        {
          "key": "Retry-After",
          "value": "60"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Wed, 20 Jun 2018 17:55:21 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Date",
          "value": "Thu, 20 Jun 2019 17:55:21 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17369-MDW"
        },
        {
          "key": "X-Cache",
          "value": "MISS"
        },
        {
          "key": "X-Cache-Hits",
          "value": "0"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"result\": {\n            \"item\": {\n                \"accounting_systemid\": \"wkMd2g\",\n                \"description\": \"Just a touring pack\",\n                \"id\": 59724,\n                \"inventory\": \"4\",\n                \"itemid\": 59724,\n                \"name\": \"Alan Touring Pack\",\n                \"qty\": \"10\",\n                \"sku\": \"SDK2919361221\",\n                \"tax1\": 0,\n                \"tax2\": 0,\n                \"unit_cost\": {\n                    \"amount\": \"550.00\",\n                    \"code\": \"USD\"\n                },\n                \"updated\": \"2019-06-20 13:50:24\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}