Chilkat Online Tools

C# / Zoho CRM REST APIs / Inventory templates

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://domain.com/crm/v2.1/settings/inventory_templates",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

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

// {
//   "inventory_templates": [
//     {
//       "created_time": "2019-08-20T11:21:30+05:30",
//       "modified_time": "2020-12-23T17:30:15+05:30",
//       "folder": {
//         "name": "Public Templates",
//         "id": "4150868000000226424"
//       },
//       "last_usage_time": null,
//       "module": {
//         "api_name": "Quotes",
//         "id": "4150868000000002219"
//       },
//       "name": "Quote Template",
//       "modified_by": {
//         "name": "Patricia Boyle",
//         "id": "4150868000000225013"
//       },
//       "id": "4150868000000227001",
//       "editor_mode": "rich_text",
//       "type": "system_templates",
//       "favorite": false,
//       "created_by": null
//     },
//     {
//       "created_time": "2020-12-21T10:33:42+05:30",
//       "modified_time": "2020-12-21T10:33:42+05:30",
//       "folder": {
//         "name": "Sample Custom Template Folder",
//         "id": "4150868000004027086"
//       },
//       "last_usage_time": null,
//       "module": {
//         "api_name": "Quotes",
//         "id": "4150868000000002219"
//       },
//       "name": "Sample",
//       "modified_by": {
//         "name": "Patricia Boyle",
//         "id": "4150868000000225013"
//       },
//       "id": "4150868000004027091",
//       "editor_mode": "gallery",
//       "type": "custom_templates",
//       "favorite": false,
//       "created_by": {
//         "name": "Patricia Boyle",
//         "id": "4150868000000225013"
//       }
//     },
//     {
//       "created_time": "2019-08-20T11:21:30+05:30",
//       "modified_time": "2019-08-20T11:21:30+05:30",
//       "folder": {
//         "name": "Public Templates",
//         "id": "4150868000000226424"
//       },
//       "last_usage_time": null,
//       "module": {
//         "api_name": "Purchase_Orders",
//         "id": "4150868000000002223"
//       },
//       "name": "Purchase Order Template",
//       "modified_by": null,
//       "id": "4150868000000227007",
//       "editor_mode": "rich_text",
//       "type": "system_templates",
//       "favorite": false,
//       "created_by": null
//     },
//     {
//       "created_time": "2019-08-20T11:21:30+05:30",
//       "modified_time": "2019-08-20T11:21:30+05:30",
//       "folder": {
//         "name": "Public Templates",
//         "id": "4150868000000226424"
//       },
//       "last_usage_time": null,
//       "module": {
//         "api_name": "Sales_Orders",
//         "id": "4150868000000002221"
//       },
//       "name": "Sales Order Template",
//       "modified_by": null,
//       "id": "4150868000000227005",
//       "editor_mode": "rich_text",
//       "type": "system_templates",
//       "favorite": false,
//       "created_by": null
//     },
//     {
//       "created_time": "2019-08-20T11:21:30+05:30",
//       "modified_time": "2019-08-20T11:21:30+05:30",
//       "folder": {
//         "name": "Public Templates",
//         "id": "4150868000000226424"
//       },
//       "last_usage_time": null,
//       "module": {
//         "api_name": "Invoices",
//         "id": "4150868000000002225"
//       },
//       "name": "Invoice Template",
//       "modified_by": null,
//       "id": "4150868000000227003",
//       "editor_mode": "rich_text",
//       "type": "system_templates",
//       "favorite": false,
//       "created_by": null
//     }
//   ],
//   "info": {
//     "per_page": 200,
//     "count": 5,
//     "page": 1,
//     "more_records": false
//   }
// }

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

string created_time;
string modified_time;
string Name;
string Id;
string last_usage_time;
string Api_name;
string moduleId;
string name;
string modified_byName;
string modified_byId;
string id;
string editor_mode;
string v_type;
bool favorite;
string created_by;
string created_byName;
string created_byId;
string modified_by;

int Per_page = jResp.IntOf("info.per_page");
int Count = jResp.IntOf("info.count");
int Page = jResp.IntOf("info.page");
bool More_records = jResp.BoolOf("info.more_records");
int i = 0;
int count_i = jResp.SizeOfArray("inventory_templates");
while (i < count_i) {
    jResp.I = i;
    created_time = jResp.StringOf("inventory_templates[i].created_time");
    modified_time = jResp.StringOf("inventory_templates[i].modified_time");
    Name = jResp.StringOf("inventory_templates[i].folder.name");
    Id = jResp.StringOf("inventory_templates[i].folder.id");
    last_usage_time = jResp.StringOf("inventory_templates[i].last_usage_time");
    Api_name = jResp.StringOf("inventory_templates[i].module.api_name");
    moduleId = jResp.StringOf("inventory_templates[i].module.id");
    name = jResp.StringOf("inventory_templates[i].name");
    modified_byName = jResp.StringOf("inventory_templates[i].modified_by.name");
    modified_byId = jResp.StringOf("inventory_templates[i].modified_by.id");
    id = jResp.StringOf("inventory_templates[i].id");
    editor_mode = jResp.StringOf("inventory_templates[i].editor_mode");
    v_type = jResp.StringOf("inventory_templates[i].type");
    favorite = jResp.BoolOf("inventory_templates[i].favorite");
    created_by = jResp.StringOf("inventory_templates[i].created_by");
    created_byName = jResp.StringOf("inventory_templates[i].created_by.name");
    created_byId = jResp.StringOf("inventory_templates[i].created_by.id");
    modified_by = jResp.StringOf("inventory_templates[i].modified_by");
    i = i + 1;
}

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/settings/inventory_templates

Postman Collection Item JSON

{
  "name": "Inventory templates",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/settings/inventory_templates",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "settings",
        "inventory_templates"
      ]
    }
  },
  "response": [
    {
      "name": "SUCCESS RESPONSE",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/inventory_templates",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "inventory_templates"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Mon, 10 May 2021 12:21:40 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-ACCESSTOKEN-RESET",
          "value": "2021-05-10T18:42:26+05:30"
        },
        {
          "key": "clientVersion",
          "value": "4016246"
        },
        {
          "key": "clientsubVersion",
          "value": "59f8474ad0046d6a2f6204e0448818d0"
        },
        {
          "key": "Content-Disposition",
          "value": "attachment; filename=response.json"
        },
        {
          "key": "vary",
          "value": "accept-encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Content-Language",
          "value": "en-US"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"inventory_templates\": [\n        {\n            \"created_time\": \"2019-08-20T11:21:30+05:30\",\n            \"modified_time\": \"2020-12-23T17:30:15+05:30\",\n            \"folder\": {\n                \"name\": \"Public Templates\",\n                \"id\": \"4150868000000226424\"\n            },\n            \"last_usage_time\": null,\n            \"module\": {\n                \"api_name\": \"Quotes\",\n                \"id\": \"4150868000000002219\"\n            },\n            \"name\": \"Quote Template\",\n            \"modified_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            },\n            \"id\": \"4150868000000227001\",\n            \"editor_mode\": \"rich_text\",\n            \"type\": \"system_templates\",\n            \"favorite\": false,\n            \"created_by\": null\n        },\n        {\n            \"created_time\": \"2020-12-21T10:33:42+05:30\",\n            \"modified_time\": \"2020-12-21T10:33:42+05:30\",\n            \"folder\": {\n                \"name\": \"Sample Custom Template Folder\",\n                \"id\": \"4150868000004027086\"\n            },\n            \"last_usage_time\": null,\n            \"module\": {\n                \"api_name\": \"Quotes\",\n                \"id\": \"4150868000000002219\"\n            },\n            \"name\": \"Sample\",\n            \"modified_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            },\n            \"id\": \"4150868000004027091\",\n            \"editor_mode\": \"gallery\",\n            \"type\": \"custom_templates\",\n            \"favorite\": false,\n            \"created_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            }\n        },\n        {\n            \"created_time\": \"2019-08-20T11:21:30+05:30\",\n            \"modified_time\": \"2019-08-20T11:21:30+05:30\",\n            \"folder\": {\n                \"name\": \"Public Templates\",\n                \"id\": \"4150868000000226424\"\n            },\n            \"last_usage_time\": null,\n            \"module\": {\n                \"api_name\": \"Purchase_Orders\",\n                \"id\": \"4150868000000002223\"\n            },\n            \"name\": \"Purchase Order Template\",\n            \"modified_by\": null,\n            \"id\": \"4150868000000227007\",\n            \"editor_mode\": \"rich_text\",\n            \"type\": \"system_templates\",\n            \"favorite\": false,\n            \"created_by\": null\n        },\n        {\n            \"created_time\": \"2019-08-20T11:21:30+05:30\",\n            \"modified_time\": \"2019-08-20T11:21:30+05:30\",\n            \"folder\": {\n                \"name\": \"Public Templates\",\n                \"id\": \"4150868000000226424\"\n            },\n            \"last_usage_time\": null,\n            \"module\": {\n                \"api_name\": \"Sales_Orders\",\n                \"id\": \"4150868000000002221\"\n            },\n            \"name\": \"Sales Order Template\",\n            \"modified_by\": null,\n            \"id\": \"4150868000000227005\",\n            \"editor_mode\": \"rich_text\",\n            \"type\": \"system_templates\",\n            \"favorite\": false,\n            \"created_by\": null\n        },\n        {\n            \"created_time\": \"2019-08-20T11:21:30+05:30\",\n            \"modified_time\": \"2019-08-20T11:21:30+05:30\",\n            \"folder\": {\n                \"name\": \"Public Templates\",\n                \"id\": \"4150868000000226424\"\n            },\n            \"last_usage_time\": null,\n            \"module\": {\n                \"api_name\": \"Invoices\",\n                \"id\": \"4150868000000002225\"\n            },\n            \"name\": \"Invoice Template\",\n            \"modified_by\": null,\n            \"id\": \"4150868000000227003\",\n            \"editor_mode\": \"rich_text\",\n            \"type\": \"system_templates\",\n            \"favorite\": false,\n            \"created_by\": null\n        }\n    ],\n    \"info\": {\n        \"per_page\": 200,\n        \"count\": 5,\n        \"page\": 1,\n        \"more_records\": false\n    }\n}"
    },
    {
      "name": "INVALID_DATA",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/inventory_templates?module=Lead",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "inventory_templates"
          ],
          "query": [
            {
              "key": "module",
              "value": "Lead"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Mon, 10 May 2021 12:22:14 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "129"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-ACCESSTOKEN-RESET",
          "value": "2021-05-10T18:42:26+05:30"
        },
        {
          "key": "clientVersion",
          "value": "4016246"
        },
        {
          "key": "clientsubVersion",
          "value": "59f8474ad0046d6a2f6204e0448818d0"
        },
        {
          "key": "Content-Disposition",
          "value": "attachment; filename=response.json"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        },
        {
          "key": "Content-Language",
          "value": "en-US"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"INVALID_DATA\",\n    \"details\": {\n        \"param_name\": \"module\"\n    },\n    \"message\": \"the module name given seems to be invalid\",\n    \"status\": \"error\"\n}"
    },
    {
      "name": "PATTERN_NOT_MATCHED",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/inventory_templates?module=\"Lead\"",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "inventory_templates"
          ],
          "query": [
            {
              "key": "module",
              "value": "\"Lead\""
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Mon, 10 May 2021 12:22:39 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "142"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"PATTERN_NOT_MATCHED\",\n    \"details\": {\n        \"api_name\": \"module\"\n    },\n    \"message\": \"Please check whether the input values are correct\",\n    \"status\": \"error\"\n}"
    },
    {
      "name": "INVALID_URL_PATTERN",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/inventory_template",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "inventory_template"
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Mon, 10 May 2021 12:23:01 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "131"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-ACCESSTOKEN-RESET",
          "value": "2021-05-10T18:42:26+05:30"
        },
        {
          "key": "Content-Disposition",
          "value": "attachment; filename=response.json"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        },
        {
          "key": "Content-Language",
          "value": "en-US"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"INVALID_URL_PATTERN\",\n    \"details\": {},\n    \"message\": \"Please check if the URL trying to access is a correct one\",\n    \"status\": \"error\"\n}"
    },
    {
      "name": "INVALID_REQUEST_METHOD",
      "originalRequest": {
        "method": "COPY",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/inventory_template",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "inventory_template"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Mon, 10 May 2021 12:23:16 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "124"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Frame-Options",
          "value": "deny"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"INVALID_REQUEST_METHOD\",\n    \"details\": {},\n    \"message\": \"The http request method type is not a valid one\",\n    \"status\": \"error\"\n}"
    },
    {
      "name": "AUTHENTICATION_FAILURE",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/inventory_template",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "inventory_template"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Mon, 10 May 2021 12:23:31 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "98"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"AUTHENTICATION_FAILURE\",\n    \"details\": {},\n    \"message\": \"Authentication failed\",\n    \"status\": \"error\"\n}"
    },
    {
      "name": "OAUTH_SCOPE_MISMATCH",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/inventory_templates",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "inventory_templates"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Thu, 13 May 2021 08:44:01 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "113"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"OAUTH_SCOPE_MISMATCH\",\n    \"details\": {},\n    \"message\": \"invalid oauth scope to access this URL\",\n    \"status\": \"error\"\n}"
    }
  ]
}