批量转换库存记录
目的
批量转换库存记录。您可以执行以下转换:
- 报价 转换为 Sales Orders 或 Invoices
- Sales Orders 到 Invoices
您可以在单个 API 调用中转换最多 50 条记录。 请注意,您只能对这些Inventory模块中的一个模块的记录执行转换操作。它是异步操作的,这意味着您不会立即收到请求的响应。相反,您将获得一个作业 ID,您可以使用该 ID 通过 批量Inventory记录转换Status API 检查您的转换请求的Status。
端点
- POST /Quotes/actions/mass_convert
- POST /Sales_Orders/actions/mass_convert
请求详情
请求 URL列表
将报价模块记录转换为Sales_Orders或Invoices:
{api-domain}/crm/{version}/Quotes/actions/mass_convert
将Sales Orders记录转换为Invoices:
{api-domain}/crm/{version}/Sales_Orders/actions/mass_convert
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope= ZohoCRM.mass_convert.{module_api_name}.CREATE
注意:请指定您尝试转换的父模块的 API 名称。
可能的模块名称
报价和Sales Orders
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Quotes/actions/mass_convert"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST输入 JSON
- convert_toJSON array, mandatory
它表示要转换记录的模块的详细信息。在示例请求中,您可以看到从报价转换为SalesOrders。
- moduleJSON object, mandatory
它表示子记录的模块详细信息。
- idstring, mandatory
它表示子模块的唯一ID。
- api_namestring, mandatory
它表示子模块的api_name。
- carry_over_tags boolean, mandatory
指定是否将标签从父记录传递到子记录。可能的值是:true 和 false。
- assign_to JSON object, optional
指定子记录的所有者详细信息。默认情况下,父记录的所有者也将被分配为转换记录的所有者。使用 获取 Users API 获取 Users 的 ID。
- related_modules JSON array, optional
它表示相关模块的 API 名称和 ID,例如任务、会议和通话。如果您想转换与请求记录相关的记录,请使用此键。
使用 模块 API 获取模块的 ID。 - ids JSON array, mandatory
指定要转换的记录的唯一ID。 使用获取记录API来获取记录ID。您最多可以指定50个记录ID。使用获取记录API来获取记录ID。
注意
- 正在转换的记录被视为父记录,而转换后的记录被视为子记录。
示例输入
Copied{
"convert_to": [
{
"module": {
"id": "2423488000000000171",
"api_name": "Sales_Orders"
},
"carry_over_tags": true
}
],
"assign_to": {
"id": "2423488000000483001"
},
"related_modules": [
{
"api_name": "Calls",
"id": "2423488000000017015"
},
{
"api_name": "Tasks",
"id": "2423488000000000143"
}
],
"ids": [
"2423488000000625004",
"2423488000000625032"
]
}可能的错误
- MANDATORY_NOT_FOUNDHTTP 400
- 缺少一个必填字段 'ids'
- 缺少一个必填字段 'convert_to'
- 缺少一个必填字段 'carry_over_tags'
- 输入主体中缺少一个必填字段 'module'
解决方法:
在输入主体中指定所有必填字段。请参阅上面的输入JSON键。
- INVALID_DATAHTTP 400
- 一个或多个给定的ID似乎无效。
- 输入主体中的ID类型不是long或string数据类型
- 'convert_to'数据类型似乎无效
- 给定的'module'数据类型似乎无效
- 提供的父模块或子模块名称无效
- 请求主体中使用了多个模块进行转换
- 父模块记录包含已删除记录的ID
解决方案:
- 指定有效的记录ID。
- ID的预期数据类型是long或string。
- 'convert_to'必须是一个JSON数组。请指定有效的数据类型。
- 'module'必须是一个JSON对象。请指定有效的数据类型。
- 指定有效的父模块或子模块名称。
- 每个操作只允许一个模块进行转换。
- 在父模块中指定未删除的记录ID
- NO_PERMISSIONHTTP 403
- AMBIGUITY_DURING_PROCESSING HTTP 400
请求正文中提供的ID不属于您尝试转换的相应模块
解决方案:您的输入正文中缺少 'convert_to' 字段。请指定所需的字段。
- LIMIT_EXCEEDEDHTTP 400
已超出限制
解决方案:您每次API调用最多只能转换50条记录。请将记录数量限制为50,然后重试。
- EXPECTED_FIELD_MISSING HTTP 400
'convert_to' JSON 数组缺失或为空
解决方案: 其中一个必填字段或 'convert_to' 键不应为空或缺失。
- INVALID_REQUEST_METHOD HTTP 400
HTTP请求方法类型无效
解决方案:您指定了一个无效的HTTP方法来访问API URL。
请指定一个有效的请求方法。请参阅上面的端点部分。 - INVALID_MODULEHTTP 400
给定的模块名称似乎无效
解决方案:您指定了一个无效的模块名称。
请指定一个有效的模块名称。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方案:客户端没有 ZohoCRM.mass_convert.Quotes.CREATE (或) ZohoCRM.mass_convert.SalesOrders.CREATE 权限。
创建一个具有所需权限的新令牌。请参阅上面的权限部分。 - AUTHENTICATION_FAILURE HTTP 401
Authentication 失败
解决方案: 在API调用的请求头中传递访问令牌。 - INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方案:指定的请求URL不正确。请指定一个有效的请求URL。请参阅上面的请求URL部分。 - INTERNAL_ERROR HTTP 500
内部服务器错误
解决方法:服务器中出现了意外且未处理的异常。请联系支持团队。
注意事项
- 要执行库存记录转换,必须在组织模块和安全控制中启用库存模块权限。如果这些权限未启用,系统将给出NO_PERMISSION错误。请注意,只有具有管理员访问权限的用户才能访问这些设置。
- 要启用组织模块权限,请转到设置 > 自定义 > 模块和字段 > 组织模块选项卡。选择要启用的模块并授予权限。
- 要启用安全控制权限,请转到设置 > 安全控制 > 配置文件。选择需要访问模块的所需配置文件(仅自定义配置文件,对于系统定义的配置文件,已启用),从导入/导出权限部分的转换和批量转换选项中选择要启用的模块(报价和SalesOrders),并授予权限。
示例响应
Copied{
"code": "SCHEDULED",
"details": {
"job_id": "2423488000000626117"
},
"message": "Mass Convert scheduled successfully",
"status": "success"
}