跳到主要内容

GET 商誉订单详情

GET 查询。query 参数:id(商誉订单ID,必填)。

接口编码所需范围后端接口
sales.goodwill.detailsales:readGET /v1/goodwill/detail(comap-sales)

请求参数(query)

字段类型必填说明
idinteger(int64)是—

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

请求示例

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

响应 data 字段

字段类型必填说明
idinteger(int64)—ID
orderNostring—销售订单号
customerIdinteger(int64)—客户ID
customerNamestring—客户名称
ownerIdinteger(int64)—负责人ID
ownerNamestring—负责人姓名
contactstring—联系人
contactPhonestring—联系人电话
addressstring—地址
reasonstring—原因
goodwillCategoryIdinteger(int64)—商誉分类ID
goodwillCategoryNamestring—商誉分类名称
goodwillCategoryColorstring—商誉分类颜色
linkedContractIdinteger(int64)—关联合同ID
linkedProjectstring—关联项目
projectIdinteger(int64)—关联项目ID
statusinteger(int32)—状态:0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消
bizStatusinteger(int32)—业务状态:0=待发货, 1=发货中, 2=已完成
remarkstring—备注
createTimestring(date-time)—创建时间
approvedAtstring(date-time)—审批时间
creatorNamestring—创建人姓名
creatorAvatarstring—创建人头像
approverNamestring—审批人姓名
flowInstanceCodestring—流程实例编号
linkedContractNostring—关联合同编号
items12GoodwillItemVO[]—明细
shipments12GoodwillShipmentVO[]—发货记录
operationLogs6GoodwillOperationLogVO[]—操作记录(时间升序)

错误处理​

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

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 sales:read否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败是
92301请求过于频繁是

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

← 返回goodwill