跳到主要内容

GET 销售订单分页查询

GET 分页查询。query 参数:pageNum、pageSize 及订单筛选字段;返回分页结构 {records,total,...}。

接口编码所需范围后端接口
sales.order.pagesales:readGET /v1/sales-order/page(comap-sales)

请求参数(query)

本接口的 query 参数由后端查询对象整体展开,接口规格未保留各字段的原始 类型,故类型列统一显示为 string。实际取值语义见「说明」列,按自然类型 传即可(如 "pageNum": 1),服务端会完成转换。

字段类型必填说明
keywordstring—关键词(模糊搜索订单编号、订单名称、合同编号、客户名称、客户单号)
contractIdstring—合同ID
customerIdstring—客户ID
projectIdstring—项目ID(精确筛选)
orderTypestring—订单类型(PTS/PTO/PTM)
statusstring—状态:0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消
bizStatusstring—业务状态:DRAFT=草稿, EXECUTING=执行中, PRODUCING=生产中, PENDING_SHIP=待发货, COMPLETED=已完成, CLOSED=已关闭
prioritystring—优先级
ownerIdstring—负责人ID
ownerScopestring—范围:ALL-全部 MINE-我负责 TEAM-团队成员负责 WATCHED/FOLLOWED-我关注客户的订单
contactNamestring—客户联系人名称(模糊搜索)
ownerNamestring—负责人名称(模糊搜索)
invoiceFilterstring—开票进度筛选: full-已全部开票 / partial-部分开票 / none-未开票
paymentFilterstring—收款进度筛选: full-已全部收款 / partial-部分收款 / none-未收款
deliveryFilterstring—发货进度筛选: full-已全部发货 / partial-部分发货 / none-未发货
shipmentBuildFilterstring—发货单创建状态筛选: NONE-未建单 / PARTIAL-部分建单 / FULL-已建单
advancedFiltersstring—高级字段筛选条件(JSON字符串),支持 {"field":{"op":"contains","value":"xxx"}}
sortFieldstring—列表排序字段:orderNo / status / bizStatus / totalAmount / createTime / updateTime,默认 c
sortOrderstring—列表排序方向:asc / desc,默认 desc
excludePurchasedstring—是否排除「已被以销定采采购完成」的订单(仅新建采购订单-以销定采下拉/弹窗传 true)。 <p>true 时按销售订单明细维度比对 SRM 有效采购数量,隐藏
pageNumstring—页码,从 1 开始
pageSizestring—每页返回的数量

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

请求示例

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)

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

错误处理​

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

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

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

← 返回销售订单