GET 商誉订单详情
GET 查询。query 参数:id(商誉订单ID,必填)。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
sales.goodwill.detail | sales:read | GET /v1/goodwill/detail(comap-sales) |
请求参数(query)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | integer(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 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | integer(int64) | — | ID |
orderNo | string | — | 销售订单号 |
customerId | integer(int64) | — | 客户ID |
customerName | string | — | 客户名称 |
ownerId | integer(int64) | — | 负责人ID |
ownerName | string | — | 负责人姓名 |
contact | string | — | 联系人 |
contactPhone | string | — | 联系人电话 |
address | string | — | 地址 |
reason | string | — | 原因 |
goodwillCategoryId | integer(int64) | — | 商誉分类ID |
goodwillCategoryName | string | — | 商誉分类名称 |
goodwillCategoryColor | string | — | 商誉分类颜色 |
linkedContractId | integer(int64) | — | 关联合同ID |
linkedProject | string | — | 关联项目 |
projectId | integer(int64) | — | 关联项目ID |
status | integer(int32) | — | 状态:0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消 |
bizStatus | integer(int32) | — | 业务状态:0=待发货, 1=发货中, 2=已完成 |
remark | string | — | 备注 |
createTime | string(date-time) | — | 创建时间 |
approvedAt | string(date-time) | — | 审批时间 |
creatorName | string | — | 创建人姓名 |
creatorAvatar | string | — | 创建人头像 |
approverName | string | — | 审批人姓名 |
flowInstanceCode | string | — | 流程实例编号 |
linkedContractNo | string | — | 关联合同编号 |
items12 | GoodwillItemVO[] | — | 明细 |
shipments12 | GoodwillShipmentVO[] | — | 发货记录 |
operationLogs6 | GoodwillOperationLogVO[] | — | 操作记录(时间升序) |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 sales:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回goodwill