跳到主要内容

POST 更新商誉订单

POST 更新,body 为 JSON 对象,字段同创建并加 id(必填)。仅草稿/已驳回可改;整单覆盖且明细整体替换。

接口编码所需范围后端接口
sales.goodwill.updatesales:writePOST /v1/goodwill/update(comap-sales)

必填字段

字段依据
id参数说明、接口规格
customerId接口规格
items接口规格

条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。

请求体字段(body)

字段类型必填说明
customerIdinteger(int64)是客户ID
customerNamestring—客户名称
ownerIdinteger(int64)—负责人ID(销售团队成员)
contactstring—联系人
contactPhonestring—联系电话
addressstring—收货地址
reasonstring—赠送原因
goodwillCategoryIdinteger(int64)—赠送类型配置 ID(goodwillCategoryId,关联 t_goodwill_category)
linkedContractIdinteger(int64)—关联合同ID
linkedProjectstring—关联项目名称
projectIdinteger(int64)—关联项目ID
remarkstring—备注
items10GoodwillItemDTO[]是明细行
idinteger(int64)是订单ID

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.goodwill.update",
"body": {
"id": "1961000000000000001",
"customerId": "1961000000000000001",
"items": []
}
}'

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 sales:write否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败先查询处理结果,禁止盲目重试
92301请求过于频繁是
92205写操作处理超时,结果未知(下游可能仍在执行)否,先查询确认结果
92302有参数相同的写请求正在处理中等待并确认前一次结果,勿重复提交

除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回goodwill