创建服务
目的
将新服务添加到您的组织。
端点
- POST /Services__s
请求详情
请求 URL
{api-domain}/crm/{version}/Services__s
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.modules.services.{operation_type}
可能的操作类型
ALL - 对服务数据具有完全访问权限
CREATE - 创建新服务
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Services__s "
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
请求 JSON 键
- 服务_Name string,必填
表示服务的Name,并接受字母数字字符。
- 持续时间整数,必填
表示该特定服务提供的时长。
可能的取值:仅接受以分钟为单位的值。必须大于 15 分钟且小于 1,440 分钟。 - 位置字符串,必填
提供服务的地点。
可选值: 'Client 添加ress', 'Business 添加ress' 和 'Business 添加ress and Client 添加ress'. - 成员JSON object,必填
包含执行该服务的用户的 ID。每个服务最多可添加 100 名成员。
- 可用性类型字符串,必填
表示向客户提供服务的可用日期。
可能的取值:'所有工作日'、'特定日期范围'、'特定日期' 和 '特定星期几'。 - 可用_From字符串,特定日期范围必填
表示日期 From 起,服务对客户可用。
- Available_Till字符串,特定日期范围必填
表示该服务对客户可用的截止日期。
- Available_DatesJSON 数组,对于“特定日期”必填
包含该服务可供客户使用的日期列表。最多可提供 20 个营业日期。取值必须符合 YYY-MM-DD 格式。
- 可用_日期JSON 数组,选择“特定日期”时必填
包含服务向客户开放的营业日列表。
- 价格整数,必填
表示为该服务分配的费用。以您组织中配置的本地货币为单位。最多可输入 16 位数字,且可保留 2 位小数。
- Available_TimingsJSON 数组(可选)
在指定的可用日期/天内,包含可供客户使用的服务时间。最多可设置两个自定义时间段。请注意,自定义的可用时间应当大于或等于服务时长。
默认值与组织配置的营业时间相同。
‘From’ 和 ‘To’ 键的值必须使用24小时制时间格式。 - 税JSON 数组,可选
包含应用于服务成本的税的 ID 和数值。您可以通过服务模块的 GET Fields API 获取税的 ID 和数值。
- Job_Sheet_Required字符串,可选
表示成员是否需要在每次服务预约结束时填写作业单。
可能的取值: 'Yes' 和 'No'。默认值为 No. - Job_Sheet_Section__s字符串,仅当 "Job_Sheet_Required":"Yes" 时为必填
表示必须与该服务关联的作业单。调用 GET Fields API 以获取您组织中可用作业单的详细信息。当 Job_Sheet_Required 为 'No' 时,Job_Sheet_Section__s 可以为 null 或不指定。
- Status字符串,可选
表示该服务是否处于启用状态。
可能的取值:'Available'、'Temporarily Unavailable' 和 'Not in Use'。默认值为 Available。 - 不可用_From字符串,当状态为暂时不可用或未使用时为必填项
表示服务自From起对客户不可用的日期和时间。该值不能晚于当前时间。此外,应采用ISO 8601 格式。
- Unavailable_Till字符串,当状态为暂时不可用时为必填
表示服务对客户不可用的截止日期和时间。应采用ISO 8601 格式。
- 描述字符串,可选
表示服务的描述(如果有)。
注意
- 每次 API 调用最多可创建 100 个服务。
- 每个组织最多可拥有 500 个活跃的服务。
- 当 Status 为 可用 时,键 'Unavailable_From' 和 'Unavailable_Till' 不是必填项。若提供了值,请确保 'Unavailable_Till' 小于当前时间。
- 未使用 Status 的服务可以在营业时间和营业日之外创建。
样例输入
Copied{
"data": [
{
"Service_Name": "AC Repair",
"Duration": "60",
"Location": "Client Address",
"Members": [
{
"Members": {
"id": "5545974000000393001"
}
}
],
"Availability_Type": "Specific Day(s)",
"Available_Days": [
"Monday",
"Tuesday"
],
"Available_Timings": [
{
"From": "10:00",
"To": "18:30"
}
],
"Price": 230.66,
"Tax": [
{
"id": "5545974000000021003",
"value": "Vat - 0.8 %"
}
],
"Status":"Available",
"Job_Sheet_Required": "Yes",
"Job_Sheet_Section__s": "Standard",
"Description":"AC repair and service at your doorstep."
}
]
}可能的错误
- DEPENDENT_FIELD_MISSINGHTTP 400
您未提供 Availability_Type、Status 和 Job_Sheet_Required 键的依赖字段。
解决方案: 请查看 Request JSON Keys 部分并指定依赖字段。 - DEPENDENT_MISMATCHHTTP 400
您为 Unavailable_Till 提供了无效的值。
解决方案:当状态为暂时不可用时,'Unavailable_Till' 的值应大于当前时间。若状态为可用,则该键的值应小于当前时间。 - DEPENDENT_MISMATCHHTTP 400
在状态为可用时,你提供了 'Unavailable_From' 或 'Unavailable_Till' 键。
解决方案:当状态为可用时,你可以选择不指定 'Unavailable_From' 和 'Unavailable_Till' 键,或者同时指定它们。不能只指定其中一个键。 - DEPENDENT_MISMATCHHTTP 400
当你已将 Job_Sheet_Required 键指定为 'No' 时,不能指定 Job-Sheet_Section__s。
解决方案:仅当 Job_Sheet_Required 被设置为 'Yes' 时,才应提供 Job_Sheet_Section__s。 - DEPENDENT_MISMATCHHTTP 400
指定的 Available Timings、Available_Days 或 Available_Dates 不在该组织的营业时间或工作日范围内。
解决方案:调用 GET Business Hours API,并在贵组织的营业时间内指定有效输入。 - INVALID_DATAHTTP 400
您提供了无效的 Availability_Type。
解决方案:您应指定以下任一选取列表值:'Every Business Days'、'Specific Date Range'、'Specific Date(s)' 和 'Specific Day(s)'。 - INVALID_DATAHTTP 400
您为 Available_Dates 键提供了无效的日期格式。
解决方案:仅使用 YYYY-MM-DD 的日期格式。 - INVALID_DATAHTTP 400
您为 Available_Timings 中的 'From' 或 'To' 键指定了无效的值。
解决方案:自定义可用时间必须采用 24 小时制时间格式。 - INVALID_DATAHTTP 400
您指定了无效的持续时间值。
解决方案:持续时间不能少于 15 分钟或多于 1,440 分钟。请注意,该值应始终以分钟为单位。 - INVALID_DATAHTTP 400
您为 Available_Timings 提供的值不满足服务时长要求。
解决方案:Available_Timings 键的值应大于或等于服务时长。 - INVALID_DATAHTTP 400
您提供了无效的Status值。
解决方案:唯一可能的取值为 'Available'、'Temporarily Unavailable' 和 'Not in Use'。 - INVALID_DATAHTTP 400
您为Unavailable_From提供了无效的值。
解决方案:请确保'Unavailable_From'的值不大于当前时间。 - INVALID_DATAHTTP 400
您在 Members 键中指定了未确认或未激活的用户 ID。
解决方案:您只能将已激活且已确认的用户添加为组织中的服务成员。 - INVALID_DATAHTTP 400
无法关联超过 100 名用户。
解决方案:您只能向某个服务添加最多 100 名成员。 - INVALID_DATAHTTP 400
Available_Till 键的值不大于 Available_From 键的值。
解决方案:当服务的 Availability_Type 为 'Specific Date Range' 时,Available_Till 日期应大于 Available_From 日期。 - INVALID_MODULEHTTP 400
您在请求 URL 中提供了无效的模块名称。
解决方案: 在请求 URL 中,您只能使用 Services__s。 - INVALID_REQUEST_METHODHTTP 400
您指定了无效的 HTTP 请求方法类型。
解决方案:在请求 URL 中仅使用 POST 方法来访问此 API。 - LIMIT_EXCEEDEDHTTP 400
您已超出组织中活跃服务数量的最大限制。
解决方案: 每个组织最多可有 500 个活跃服务。 - OAUTH_SCOPE_MISMATCHHTTP 401
您使用了错误的 OAuth 作用域创建了授权令牌。
解决方案: 请使用 ZohoCRM.modules.services.CREATE 或 ZohoCRM.modules.services.ALL 作用域来创建新的有效授权令牌。 - INVALID_TOKENHTTP 401
您使用了无效的 OAuth 令牌。
解决方案:您使用的访问令牌已过期。请刷新您的令牌并重试。 - NO_PERMISSIONHTTP 403
您没有权限创建任何服务。
解决方案:请联系您的系统管理员。 - NOT_ALLOWEDHTTP 403
在服务 Preferences 中,未为您的组织配置作业表。
解决方案:在创建包含作业表的服务之前,请启用作业表首选项。您可以使用 Update Service Preferences API 来 Update 配置。 - NOT_ALLOWEDHTTP 403
当服务可用性日期已在过去时,您指定了 'Available' 状态。
解决方案:当 Available_Dates 位于过去时,您不能将服务标记为可用或暂时不可用。 - INVALID_URL_PATTERNHTTP 404
请检查您是否正在尝试访问正确的 URL。
解决方案:您提供了无效的请求 URL。在该 URL 中仅使用 /Services__s 端点。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器发生了意外且未处理的异常。请联系我们的支持团队。
示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2023-03-29T21:19:19+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "5545974000000393001"
},
"Created_Time": "2023-03-29T21:19:19+05:30",
"id": "5545974000002180641",
"Created_By": {
"name": "Patricia Boyle",
"id": "5545974000000393001"
}
},
"message": "record added",
"status": "success"
}
]
}