GET 销售订单分页查询
GET 分页查询。query 参数:pageNum、pageSize 及订单筛选字段;返回分页结构 {records,total,...}。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
sales.order.page | sales:read | GET /v1/sales-order/page(comap-sales) |
请求参数(query)
本接口的 query 参数由后端查询对象整体展开,接口规格未保留各字段的原始 类型,故类型列统一显示为
string。实际取值语义见「说明」列,按自然类型 传即可(如"pageNum": 1),服务端会完成转换。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
keyword | string | — | 关键词(模糊搜索订单编号、订单名称、合同编号、客户名称、客户单号) |
contractId | string | — | 合同ID |
customerId | string | — | 客户ID |
projectId | string | — | 项目ID(精确筛选) |
orderType | string | — | 订单类型(PTS/PTO/PTM) |
status | string | — | 状态:0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消 |
bizStatus | string | — | 业务状态:DRAFT=草稿, EXECUTING=执行中, PRODUCING=生产中, PENDING_SHIP=待发货, COMPLETED=已完成, CLOSED=已关闭 |
priority | string | — | 优先级 |
ownerId | string | — | 负责人ID |
ownerScope | string | — | 范围:ALL-全部 MINE-我负责 TEAM-团队成员负责 WATCHED/FOLLOWED-我关注客户的订单 |
contactName | string | — | 客户联系人名称(模糊搜索) |
ownerName | string | — | 负责人名称(模糊搜索) |
invoiceFilter | string | — | 开票进度筛选: full-已全部开票 / partial-部分开票 / none-未开票 |
paymentFilter | string | — | 收款进度筛选: full-已全部收款 / partial-部分收款 / none-未收款 |
deliveryFilter | string | — | 发货进度筛选: full-已全部发货 / partial-部分发货 / none-未发货 |
shipmentBuildFilter | string | — | 发货单创建状态筛选: NONE-未建单 / PARTIAL-部分建单 / FULL-已建单 |
advancedFilters | string | — | 高级字段筛选条件(JSON字符串),支持 {"field":{"op":"contains","value":"xxx"}} |
sortField | string | — | 列表排序字段:orderNo / status / bizStatus / totalAmount / createTime / updateTime,默认 c |
sortOrder | string | — | 列表排序方向:asc / desc,默认 desc |
excludePurchased | string | — | 是否排除「已被以销定采采购完成」的订单(仅新建采购订单-以销定采下拉/弹窗传 true)。 <p>true 时按销售订单明细维度比对 SRM 有效采购数量,隐藏 |
pageNum | string | — | 页码,从 1 开始 |
pageSize | string | — | 每页返回的数量 |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.order.page",
"query": {
"pageNum": 1,
"pageSize": 10
}
}'
响应 data 字段(分页结构:records[] + total)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
size | integer(int64) | — | — |
records49 | OrderPageVO[] | — | — |
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 为准。完整的平台层错误码见错误码说明。
← 返回销售订单