Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "item": {
# "name": "Touring Pack",
# "description": "Just a touring pack",
# "inventory": "4"
# }
# }
$json = chilkat::CkJsonObject->new();
$json->UpdateString("item.name","Touring Pack");
$json->UpdateString("item.description","Just a touring pack");
$json->UpdateString("item.inventory","4");
# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");
$http->SetRequestHeader("Content-Type","application/json");
$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);
# resp is a HttpResponse
$resp = $http->PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/{{itemId}}",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "response": {
# "result": {
# "item": {
# "accounting_systemid": "wkMd2g",
# "description": "Backpack with ferns",
# "id": 59704,
# "inventory": "55",
# "itemid": 59704,
# "name": "Backpack",
# "qty": "20",
# "tax1": 0,
# "tax2": 0,
# "unit_cost": {
# "amount": "750.00",
# "code": "USD"
# },
# "updated": "2019-04-19 08:09:32",
# "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
$Accounting_systemid = $jResp->stringOf("response.result.item.accounting_systemid");
$Description = $jResp->stringOf("response.result.item.description");
$Id = $jResp->IntOf("response.result.item.id");
$Inventory = $jResp->stringOf("response.result.item.inventory");
$Itemid = $jResp->IntOf("response.result.item.itemid");
$Name = $jResp->stringOf("response.result.item.name");
$Qty = $jResp->stringOf("response.result.item.qty");
$Tax1 = $jResp->IntOf("response.result.item.tax1");
$Tax2 = $jResp->IntOf("response.result.item.tax2");
$Amount = $jResp->stringOf("response.result.item.unit_cost.amount");
$Code = $jResp->stringOf("response.result.item.unit_cost.code");
$Updated = $jResp->stringOf("response.result.item.updated");
$Vis_state = $jResp->IntOf("response.result.item.vis_state");
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"item": {
"name": "Touring Pack",
"description": "Just a touring pack",
"inventory": "4"
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/{{itemId}}
Postman Collection Item JSON
{
"name": "Update Item",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"itemId\", jsonData.response.result.item.itemId);",
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"item\": {\n\t\t\"name\": \"Touring Pack\",\n\t\t\"description\": \"Just a touring pack\",\n\t\t\"inventory\": \"4\"\n\t}\n}"
},
"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}}"
]
},
"description": "Changing the name, description and the inventory level of the current item."
},
"response": [
{
"name": "Create Item",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": " {\n \"item\": {\n \"name\": \"Backpack\",\n \"qty\": \"20\",\n \"inventory\": \"55\",\n \"unit_cost\": {\n \"amount\": \"750.00\",\n \"code\": \"CAD\"\n },\n \"vis_state\": 0,\n \"description\": \"Backpack with ferns\"\n }\n }"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/items/items",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"items",
"items"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNRVNeEVwKFlUPS0AUCBgCHVQBVQFXB1pSAwZQVFAIBwdIU1cAHRUHXAUGV1ZVUVIAAVxUCAEFEB8DWA1CBG4="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Thu, 19 Apr 2018 12:09:32 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": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Fri, 19 Apr 2019 12:09:32 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17357-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\": \"Backpack with ferns\",\n \"id\": 59704,\n \"inventory\": \"55\",\n \"itemid\": 59704,\n \"name\": \"Backpack\",\n \"qty\": \"20\",\n \"tax1\": 0,\n \"tax2\": 0,\n \"unit_cost\": {\n \"amount\": \"750.00\",\n \"code\": \"USD\"\n },\n \"updated\": \"2019-04-19 08:09:32\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
