Zoho crm Logo

库存模板

目的

获取库存模板的详细信息。

请求详情

请求 URL

{api-domain}/crm/{version}/settings/inventory_templates

获取特定模板的详细信息
{api-domain}/crm/{version}/settings/inventory_templates/{id}

支持的模块

报价,Invoices,Purchase Orders,以及SalesOrders。

所有在模块 API中键 "inventory_template_supported" 的值为 true 的模块都在此支持。

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.templates.inventory.READ

端点

  • GET /settings/inventory_templates
  • GET /settings/inventory_templates/{template_id}
参数
  • module string,optional

    指定要从中获取库存模板的模块的 API 名称。请参阅上面的支持的模块部分。

  • category string,optional

    根据类型过滤库存模板。可能的值有favorite:标记为您最喜欢的模板,created_by_me:您创建的模板,shared_with_me:其他用户与您共享的模板,以及draft:您的草稿模板。

  • sort_by string, optional

    指定您希望如何排序模板。可能的值有 modified_time:根据修改时间排序,last_usage_time:根据模板的最近使用时间排序,name:根据模板的名称排序。默认值是 modified_time。

  • sort_order string, optional

    您希望对模板进行排序的顺序。可能的值是asc:按升序排序和desc:按降序排序,这是默认值。

注意

  • sort_order 参数适用于给定的 sort_by 参数值。
  • content 键包含电子邮件模板的 HTML,并且仅在您获取特定电子邮件模板时在响应中呈现。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/inventory_templates"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

响应 JSON 键

  • created_timestring

    表示库存模板创建的日期和时间。

  • modified_timestring

    表示库存模板最后修改的日期和时间。

  • folderJSON object

    表示模板文件夹的名称和唯一ID。

  • last_usage_timestring

    表示库存模板上次使用的日期和时间。

  • 模块JSON object

    表示与库存模板关联的模块的 API 名称和唯一 ID。

  • namestring

    表示模板的名称。

  • modified_byJSON object

    表示最后修改库存模板的用户的姓名和ID。

  • idstring

    表示库存模板的唯一ID。

  • editor_modestring

    表示创建Inventory模板的模式。可能的值有gallery:从模板库中选择并自定义模板,rich_text: 预设计的自定义模板,plain_text: 从头开始构建模板。
    要了解更多关于编辑模式的信息,请参阅创建InventoryTemplates。

  • favoriteboolean

    表示库存模板是否被标记为收藏。

  • categorystring

    表示模板的类别。可能的值有 custom_templates:用户创建的模板,system_templates:系统默认存在的模板,plugin_templates:从Zoho CRM扩展中创建和安装的模板,marketplace_templates:从已发布的插件中创建和安装的模板。

  • created_byJSON object

    表示创建库存模板的用户的姓名和ID。

可能的错误

  • INVALID_MODULEHTTP 400

    指定的模块名称无效。
    解决方法:请指定有效的模块 API 名称。请参阅上面的支持的模块部分。

  • PATTERN_NOT_MATCHEDHTTP 400

    您为响应中的 "api_name" 指定了不正确的值。
    解决方法:输入正确的值。

  • FEATURE_NOT_SUPPORTEDHTTP 403

    此功能不支持您的版本。
    解决方法:请联系您的管理员。

  • NO_PERMISSIONHTTP 403

    您没有权限查看此模块的模板。
    解决方案:请联系您的管理员。

  • INVALID_URL_PATTERNHTTP 404

    请检查尝试访问的URL是否正确。
    解决方案:请求的URL不正确。请指定一个有效的请求URL。请参阅上面的请求URL部分。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方法: 客户端没有 ZohoCRM.templates.inventory.READ 范围。创建一个具有有效范围的新客户端。请参阅上面的范围部分。

  • INTERNAL_ERRORHTTP 500

    内部服务器错误
    解决方法:服务器中出现意外且未处理的异常。请联系支持团队。

  • INVALID_REQUEST_METHODHTTP 400

    HTTP请求方法类型无效
    解决方案:您指定了一个无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参阅上面的端点部分。

  • AUTHORIZATION_FAILEDHTTP 400

    用户没有足够的权限读取记录数据
    解决方案:用户没有权限检索记录数据。请联系系统管理员。

示例响应

Copied{
    "inventory_templates": [
        {
            "created_time": "2021-08-09T09:52:11+05:30",
            "modified_time": "2021-08-09T09:52:11+05:30",
            "folder": {
                "name": "Public Templates",
                "id": "4876876000000329734"
            },
            "last_usage_time": null,
            "module": {
                "api_name": "Purchase_Orders",
                "id": "4876876000000002223"
            },
            "name": "Purchase Order Template",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            },
            "id": "4876876000000329743",
            "editor_mode": "rich_text",
            "category": "system_templates",
            "favorite": false,
            "created_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            }
        },
        {
            "created_time": "2021-08-09T09:52:11+05:30",
            "modified_time": "2021-08-09T09:52:11+05:30",
            "folder": {
                "name": "Public Templates",
                "id": "4876876000000329734"
            },
            "last_usage_time": null,
            "module": {
                "api_name": "Sales_Orders",
                "id": "4876876000000002221"
            },
            "name": "Sales Order Template",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            },
            "id": "4876876000000329741",
            "editor_mode": "rich_text",
            "category": "system_templates",
            "favorite": false,
            "created_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            }
        },
        {
            "created_time": "2021-08-09T09:52:11+05:30",
            "modified_time": "2021-08-09T09:52:11+05:30",
            "folder": {
                "name": "Public Templates",
                "id": "4876876000000329734"
            },
            "last_usage_time": null,
            "module": {
                "api_name": "Invoices",
                "id": "4876876000000002225"
            },
            "name": "Invoice Template",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            },
            "id": "4876876000000329739",
            "editor_mode": "rich_text",
            "category": "system_templates",
            "favorite": false,
            "created_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            }
        },
        {
            "created_time": "2021-08-09T09:52:10+05:30",
            "modified_time": "2021-08-09T09:52:10+05:30",
            "folder": {
                "name": "Public Templates",
                "id": "4876876000000329734"
            },
            "last_usage_time": null,
            "module": {
                "api_name": "Quotes",
                "id": "4876876000000002219"
            },
            "name": "Quote Template",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            },
            "id": "4876876000000329737",
            "editor_mode": "rich_text",
            "category": "system_templates",
            "favorite": false,
            "created_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            }
        }
    ],
    "info": {
        "per_page": 200,
        "count": 4,
        "page": 1,
        "more_records": false
    }
}