POST 商誉订单分页查询
POST 查询,body 为 JSON 对象:pageNum、pageSize;可选 keyword(订单号)、customerId、goodwillCategoryId(赠送类型)、status(0草稿/1待审批/2已审批/3已驳回/4已取消)、bizStatus(0待发货/1发货中/2已完成)、listTab(1草稿/2待审批/3已审批待发货/4已驳回/5发货中/6已完成/7已取消)、linkedContractId、projectId、includeLinePreview(true时带明细预览)。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
sales.goodwill.page | sales:read | POST /v1/goodwill/page(comap-sales) |
请求体字段(body)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
pageNum | integer(int32) | — | 页码,从 1 开始 |
pageSize | integer(int32) | — | 每页返回的数量 |
keyword | string | — | 关键词(订单号) |
customerId | integer(int64) | — | 客户ID |
goodwillCategoryId | integer(int64) | — | 赠送类型筛选(goodwillCategoryId) |
status | integer(int32) | — | 状态:0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消 |
linkedContractId | integer(int64) | — | 关联合同ID |
projectId | integer(int64) | — | 关联项目ID |
includeLinePreview | boolean | — | 为 true 时填充行预览、最近发货日期(合同详情 Tab 等;不传或 false 时与原有分页一致) / |
listTab | integer(int32) | — | 列表状态 Tab:null 表示全部。1 草稿 2 待审批 3 已审批(待发货) 4 已驳回 5 发货中 6 已完成 7 已取消 / |
bizStatus | integer(int32) | — | 业务状态:0=待发货, 1=发货中, 2=已完成 |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.goodwill.page",
"body": {
"pageNum": 1,
"pageSize": 10
}
}'
响应 data 字段(分页结构:records[] + total)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
size | integer(int64) | — | — |
records19 | GoodwillPageVO[] | — | — |
total | integer(int64) | — | — |
current | integer(int64) | — | — |
pages | integer(int64) | — | — |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 sales:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回goodwill