跳到主要内容

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.pagesales:readPOST /v1/goodwill/page(comap-sales)

请求体字段(body)

字段类型必填说明
pageNuminteger(int32)—页码,从 1 开始
pageSizeinteger(int32)—每页返回的数量
keywordstring—关键词(订单号)
customerIdinteger(int64)—客户ID
goodwillCategoryIdinteger(int64)—赠送类型筛选(goodwillCategoryId)
statusinteger(int32)—状态:0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消
linkedContractIdinteger(int64)—关联合同ID
projectIdinteger(int64)—关联项目ID
includeLinePreviewboolean—为 true 时填充行预览、最近发货日期(合同详情 Tab 等;不传或 false 时与原有分页一致) /
listTabinteger(int32)—列表状态 Tab:null 表示全部。1 草稿 2 待审批 3 已审批(待发货) 4 已驳回 5 发货中 6 已完成 7 已取消 /
bizStatusinteger(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)

字段类型必填说明
sizeinteger(int64)——
records19GoodwillPageVO[]——
totalinteger(int64)——
currentinteger(int64)——
pagesinteger(int64)——

错误处理​

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

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

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

← 返回goodwill