官网
帮助中心 / 开放能力 / 销售 API 接口文档

销售 API 接口文档

分类：开放能力 ｜ 适用：开发者、IT、集成商 ｜ 接口数：2
这帮你解决什么：销售模块开放API:销售订单查询/详情接口,获取销售数据。共 2 个接口,含请求参数和响应字段。

接口概览

接口方式路径说明
分页查询销售订单POST/open/api/saas/erp/order/menuPage根据多种条件分页查询销售订单信息，支持按订单号、客户、商品、时间范围等多维度筛选
查询销售订单详情POST/open/api/saas/erp/order/detail根据订单业务ID查询销售订单的详细信息

1. 分页查询销售订单

方式: POST ｜ 路径: /open/api/saas/erp/order/menuPage

根据多种条件分页查询销售订单信息，支持按订单号、客户、商品、时间范围等多维度筛选

请求参数

参数名类型必填说明
pageNumInteger是当前页码，最小值为1
pageSizeInteger是每页数量，最大值为1000
bizKeyLong否订单业务ID
bizKeysList<Long>否订单业务ID集合
keywordSearchString否关键字搜索
orderCodeString否订单编号
orderNameString否订单名称
orderCycleListList<Integer>否订单周期列表
goodsIdListList<Long>否商品ID列表
goodsNameString否商品名称
itemNameString否成品/物料名称
customerIdListList<Long>否客户ID列表
customerIdLong否客户ID
customerNameString否客户名称
orderAmountStartBigDecimal否订单总金额（不含税）开始
orderAmountEndBigDecimal否订单总金额（不含税）结束
orderTaxAmountStartBigDecimal否订单总税额开始
orderTaxAmountEndBigDecimal否订单总税额结束
totalAmountStartBigDecimal否订单总金额（含税）开始
totalAmountEndBigDecimal否订单总金额（含税）结束
orderStatusInteger否订单状态
orderStatusListList<Integer>否订单状态列表
paymentStatusInteger否收款状态
paymentStatusListList<Integer>否收款状态列表
invoiceStatusListList<Integer>否开票状态列表
createTimeStartDate否创建时间开始
createTimeEndDate否创建时间结束
orderManagerNameString否销售负责人
sortListList<FieldSortVO>否排序集合，详见FieldSortVO对象
fieldCategoryInteger否自定义字段归属类型
fieldCodeString是属性编码
sortTypeInteger是排序类型

响应参数

参数名类型必填说明
codeString是响应码
messageString是响应消息
pageNumInteger是当前页码
pageSizeInteger是每页数量
pagesInteger是总页数
totalLong是总记录数
bizKeyLong是订单业务id
orderCodeString是订单编号
orderNameString是订单名称
paymentStatusInteger是收款状态
directlyDeliveryFlagBoolean是是否直接发货
orderCycleListList<OrderCycleVO>是orderAmount
BigDecimal是金额（不含税）orderAmountDes
String是金额（不含税）加密orderTaxAmount
BigDecimal是税额orderTaxAmountDes
String是税额加密totalAmount
BigDecimal是总金额（含税）totalAmountDes
String是总金额（含税）加密receiptTotalAmount
BigDecimal是收款金额receiptTotalAmountDes
String是收款金额加密receiptProgress
BigDecimal是收款进度invoiceTotalAmount
BigDecimal是开票金额invoiceTotalAmountDes
String是开票金额加密invoiceProgress
BigDecimal是开票进度invoiceStatus
BigDecimal是开票状态totalNum
BigDecimal是数量totalMaterialNum
BigDecimal是物料数量customerId
Long是客户idcustomerName
String是客户名称createTime
Date是创建时间orderStatus
Integer是订单状态deliveryNum
BigDecimal是已发货数量deliveryMaterialNum
BigDecimal是已发货物料数量targetStatusList
List<OrderTargetStatusRespVO>是orderDetailTypeInteger
是订单明细类型（1成品 2物料）orderGoodsNamesString
是订单商品名称orderMaterialNamesString
是订单物料名称customFieldList<CustomFieldVO>
是自定义字段orderProjectListList<OrderRelProjectVO>
是orderProductListList<OrderRelProductVO>是
orderDeliveryListList<OrderRelDeliveryVO>是remark
String是备注orderManagerList
List<OrderManagerRespVO>是approverListList<OrderApproverRespVO>
是approveGroupInteger是
审批人组别(TenantSettingBillApproveGroupEnum)canApproveFlagBoolean是
是否可审批syncRemarkToProductionFlagBoolean是
是否同步备注到生产订单creditCodeString是
信用代码bankCodeString是
银行编码bankNameString是
银行名称bankAccountString是
银行账号bankAccountDesString是
银行账号DesorderCycleInteger是
订单周期orderCycleNameString是
订单周期名称targetOrderStatusInteger是
状态targetOrderStatusNameString是
状态名称projectIdLong是
项目idprojectCodeString是
项目编号projectNameString是
项目名称projectStatusInteger是
项目状态productionOrderIdLong是
生产订单idproductionOrderCodeString是
生产订单编号deliveryIdLong是
发货iddeliveryCodeString是
发货编号customerIdLong是
商品idcustomerNameString是
商品编号approveIdLong是
审批人idapproveNameString是
审批人名称{
 "pageNum": 1,
 "pageSize": 20,
 "bizKey": 123456,
 "bizKeys": [123456, 123457],
 "keywordSearch": "关键字",
 "orderCode": "SO202601001",
 "orderName": "订单A",
 "orderCycleList": [1, 2],
 "goodsIdList": [4001, 4002],
 "goodsName": "产品A",
 "itemName": "成品A",
 "customerIdList": [2001, 2002],
 "customerId": 2001,
 "customerName": "客户A",
 "orderAmountStart": 10000.00,
 "orderAmountEnd": 100000.00,
 "orderTaxAmountStart": 1000.00,
 "orderTaxAmountEnd": 10000.00,
 "totalAmountStart": 11000.00,
 "totalAmountEnd": 110000.00,
 "orderStatus": 2,
 "orderStatusList": [1, 2, 3],
 "paymentStatus": 1,
 "paymentStatusList": [1, 2],
 "invoiceStatusList": [1, 2],
 "createTimeStart": "2026-01-01 00:00:00",
 "createTimeEnd": "2026-01-31 23:59:59",
 "orderManagerName": "张三",
 "sortList": [
 {
 "fieldCode": "createTime",
 "sortType": 2
 }
 ],
 "fieldCategory": 1
}{
 "code": "200",
 "message": "success",
 "data": {
 "pageNum": 1,
 "pageSize": 20,
 "pages": 5,
 "total": 100,
 "data": [
 {
 "bizKey": 123456,
 "orderCode": "SO202601001",
 "orderName": "订单A",
 "paymentStatus": 1,
 "directlyDeliveryFlag": false,
 "orderCycleList": [
 {
 "orderCycle": 1,
 "orderCycleName": "首次订单"
 }
 ],
 "orderAmount": 50000.00,
 "orderAmountDes": "50000.00",
 "orderTaxAmount": 6500.00,
 "orderTaxAmountDes": "6500.00",
 "totalAmount": 56500.00,
 "totalAmountDes": "56500.00",
 "receiptTotalAmount": 20000.00,
 "receiptTotalAmountDes": "20000.00",
 "receiptProgress": 0.35,
 "invoiceTotalAmount": 30000.00,
 "invoiceTotalAmountDes": "30000.00",
 "invoiceProgress": 0.53,
 "invoiceStatus": 2,
 "totalNum": 100,
 "totalMaterialNum": 500,
 "customerId": 2001,
 "customerName": "客户A",
 "createTime": "2026-01-15 10:30:00",
 "orderStatus": 2,
 "deliveryNum": 10,
 "deliveryMaterialNum": 50,
 "targetStatusList": [
 {
 "targetOrderStatus": 3,
 "targetOrderStatusName": "已审批"
 }
 ],
 "orderDetailType": 1,
 "orderGoodsNames": "产品A,产品B",
 "orderMaterialNames": "物料A,物料B",
 "customField": [],
 "orderProjectList": [
 {
 "projectId": 3001,
 "projectCode": "PROJ001",
 "projectName": "项目A",
 "projectStatus": 2
 }
 ],
 "orderProductList": [
 {
 "productionOrderId": 4001,
 "productionOrderCode": "MO202601001"
 }
 ],
 "orderDeliveryList": [
 {
 "deliveryId": 5001,
 "deliveryCode": "DEL202601001"
 }
 ],
 "remark": "备注信息",
 "orderManagerList": [
 {
 "customerId": 10001,
 "customerName": "张三"
 }
 ],
 "approverList": [
 {
 "approveId": 11001,
 "approveName": "李四"
 }
 ],
 "approveGroup": 1,
 "canApproveFlag": false,
 "syncRemarkToProductionFlag": true,
 "creditCode": "91440300XXXXXXXXXX",
 "bankCode": "ICBC",
 "bankName": "中国工商银行",
 "bankAccount": "6222************1234",
 "bankAccountDes": "6222************1234"
 }
 ]
 }
}成功
-请求成功参数错误-
请求参数不合法未授权-未登录或token失效
禁止访问-无权限访问该接口服务器错误

2. 查询销售订单详情

方式: POST ｜ 路径: /open/api/saas/erp/order/detail

根据订单业务ID查询销售订单的详细信息

请求参数

参数名类型必填说明
bizKeyLong是订单业务ID

响应参数

参数名类型必填说明
codeString是响应码
messageString是响应消息
是订单业务IDcustomerIdLong
是客户IDcustomerNameString
是客户名称companyNameString
是公司名称contactNumberString
是客户手机号contactNumberDesString
是客户手机号（加密）orderCodeString
是订单编号orderNameString
是订单名称paymentStatusInteger
是收款状态directlyDeliveryFlagBoolean
是是否直接发货orderCycleListList<OrderCycleVO>
是orderStatusInteger是
订单状态orderAmountBigDecimal是
金额totalNumBigDecimal是
数量remarkString是
备注orderDetailListList<OrderDetailRespVO>是
orderMaterialDetailListList<OrderMaterialDetailRespVO>是customField
List<CustomFieldVO>是自定义字段列表orderManagerList
List<OrderManagerRespVO>是orderContractListList<OrderContractVO>
是approvalOpinionString是
审批意见approvalIdLong是
审批人IDapprovalNameString是
审批人名称approvalTimeDate是
审批时间quotationOrderIdLong是
报价单IDprovinceCodeInteger是
客户-省编码provinceString是
客户-省cityCodeInteger是
客户-市编码cityString是
客户-市districtCodeInteger是
客户-区编码districtString是
客户-区streetCodeInteger是
客户-街道编码streetString是
客户-街道addressString是
客户-详细地址addressDesString是
客户-详细地址（加密）creditCodeString是
信用代码bankCodeString是
银行编码bankNameString是
银行名称bankAccountString是
银行账号bankAccountDesString是
银行账号（加密）orderCycleInteger是
订单周期orderCycleNameString是
订单周期名称goodsIdLong是
商品idgoodsCodeString是
商品编号goodsNameString是
商品名称specString是
规格calculationBaseTypeInteger是
计算基数类型unitPriceBigDecimal是
单价unitPriceDesString是
单价（加密）saleNumBigDecimal是
销售数量goodsAmountBigDecimal是
商品总金额（不含税）taxRateBigDecimal是
税率taxAmountBigDecimal是
税额totalAmountBigDecimal是
商品总金额（含税）saleDataDate是
销售日期researchFlagBoolean是
是否下发研发needProductionNumBigDecimal是
需要生产数量remarkString是
备注stockNumBigDecimal是
当前库存occupancyStockNumBigDecimal是
占用库存数量availableStockNumBigDecimal是
可用库存数量 = 在库库存数量 - 占用库存数量outboundNumBigDecimal是
已出库数量noOutboundNumBigDecimal是
待出库数量returnNumBigDecimal是
退货数量hasDeliveryNumBigDecimal是
已发货数量unitNameString是
单位名称unitValueString是
单位值categoryNameString是
商品分类名称categoryValueString是
商品分类值businessOpportunityIdListList<Long>是
商机idbomInfoBOListList<BomSimpleInfoVO>是
existProjectFlagBoolean是是否存在项目
existProductionFlagBoolean是是否存在生产订单
existDeliveryFlagBoolean是是否存在发货单
bomIdLong是bomId
bomCodeString是bom编号
bomNameString是bom名称
productionTechnologyIdLong是工艺路线id
productionTechnologyCodeString是工艺路线编号
productionTechnologyNameString是工艺路线名称
defaultFlagBoolean是是否默认
materialIdLong是物料id
materialCodeString是物料编号
materialNameString是物料名称
materialCategoryIdLong是物料类别id
materialCategoryNameString是物料类别名称
materialTypeInteger是物料类型
specificationString是规格型号
mallNumberString是自定义编号
calculationBaseTypeInteger是计算基数类型
unitPriceBigDecimal是单价
unitPriceDesString是单价（加密）
saleNumBigDecimal是销售数量
materialAmountBigDecimal是物料总金额
taxRateBigDecimal是税率
taxAmountBigDecimal是税额
totalAmountBigDecimal是商品总金额（含税）
saleDataDate是销售日期
remarkString是备注
stockNumBigDecimal是当前库存
outboundNumBigDecimal是已出库数量
noOutboundNumBigDecimal是待出库数量
returnNumBigDecimal是退货数量
hasDeliveryNumBigDecimal是已发货数量
unitNameString是单位名称
unitValueString是单位值
existProjectFlagBoolean是是否存在项目
existProductionFlagBoolean是是否存在生产订单
existDeliveryFlagBoolean是是否存在发货单
customerIdLong是商品id
customerNameString是商品编号
orderContractFileAccessIdString是订单合同文件id
orderContractFileNameString是订单合同文件名称
orderContractFileExtensionString是订单合同文件后缀
{
 "bizKey": 123456
}{
 "code": "200",
 "message": "success",
 "data": {
 "bizKey": 123456,
 "customerId": 2001,
 "customerName": "客户A",
 "companyName": "XX科技有限公司",
 "contactNumber": "138****5678",
 "contactNumberDes": "138****5678",
 "orderCode": "SO202601001",
 "orderName": "订单A",
 "paymentStatus": 1,
 "directlyDeliveryFlag": false,
 "orderCycleList": [
 {
 "orderCycle": 1,
 "orderCycleName": "首次订单"
 }
 ],
 "orderStatus": 2,
 "orderAmount": 50000.00,
 "totalNum": 100,
 "remark": "备注信息",
 "orderDetailList": [
 {
 "goodsId": 4001,
 "goodsCode": "GOODS001",
 "goodsName": "产品A",
 "spec": "规格A",
 "calculationBaseType": 1,
 "unitPrice": 500.00,
 "unitPriceDes": "500.00",
 "saleNum": 100,
 "goodsAmount": 50000.00,
 "taxRate": 0.13,
 "taxAmount": 6500.00,
 "totalAmount": 56500.00,
 "saleData": "2026-01-15 00:00:00",
 "researchFlag": false,
 "needProductionNum": 100,
 "remark": "商品备注",
 "stockNum": 50,
 "occupancyStockNum": 20,
 "availableStockNum": 30,
 "outboundNum": 10,
 "noOutboundNum": 90,
 "returnNum": 0,
 "hasDeliveryNum": 10,
 "unitName": "个",
 "unitValue": "pcs",
 "categoryName": "电子产品",
 "categoryValue": "electronics",
 "businessOpportunityIdList": [5001],
 "bomInfoBOList": [
 {
 "bomId": 6001,
 "bomCode": "BOM001",
 "bomName": "产品A BOM",
 "productionTechnologyId": 7001,
 "productionTechnologyCode": "TECH001",
 "productionTechnologyName": "工艺路线A",
 "defaultFlag": true
 }
 ],
 "existProjectFlag": true,
 "existProductionFlag": true,
 "existDeliveryFlag": false
 }
 ],
 "orderMaterialDetailList": [
 {
 "materialId": 8001,
 "materialCode": "MAT001",
 "materialName": "物料A",
 "materialCategoryId": 9001,
 "materialCategoryName": "原材料",
 "materialType": 1,
 "specification": "规格B",
 "mallNumber": "MALL001",
 "calculationBaseType": 1,
 "unitPrice": 10.00,
 "unitPriceDes": "10.00",
 "saleNum": 500,
 "materialAmount": 5000.00,
 "taxRate": 0.13,
 "taxAmount": 650.00,
 "totalAmount": 5650.00,
 "saleData": "2026-01-15 00:00:00",
 "remark": "物料备注",
 "stockNum": 1000,
 "outboundNum": 100,
 "noOutboundNum": 400,
 "returnNum": 0,
 "hasDeliveryNum": 100,
 "unitName": "千克",
 "unitValue": "kg",
 "existProjectFlag": false,
 "existProductionFlag": false,
 "existDeliveryFlag": false
 }
 ],
 "customField": [],
 "orderManagerList": [
 {
 "customerId": 10001,
 "customerName": "张三"
 }
 ],
 "orderContractList": [
 {
 "orderContractFileAccessId": "file123456",
 "orderContractFileName": "销售合同.pdf",
 "orderContractFileExtension": "pdf"
 }
 ],
 "approvalOpinion": "同意",
 "approvalId": 11001,
 "approvalName": "李四",
 "approvalTime": "2026-01-16 10:00:00",
 "quotationOrderId": 12001,
 "provinceCode": 440000,
 "province": "广东省",
 "cityCode": 440300,
 "city": "深圳市",
 "districtCode": 440305,
 "district": "南山区",
 "streetCode": 440305001,
 "street": "粤海街道",
 "address": "科技园南区",
 "addressDes": "科技园南区",
 "creditCode": "91440300XXXXXXXXXX",
 "bankCode": "ICBC",
 "bankName": "中国工商银行",
 "bankAccount": "6222************1234",
 "bankAccountDes": "6222************1234"
 }
}成功-
请求成功参数错误-请求参数不合法
未授权-未登录或token失效禁止访问
-无权限访问该接口服务器错误-
© 嘉立创云ERP帮助中心 ｜ 本文档以客户视角编写，内容持续更新