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

采购 API 接口文档

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

接口概览

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

1. 分页查询采购订单

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

根据多种条件分页查询采购订单信息，支持按采购单号、物料信息、供应商、时间范围等多维度筛选

请求参数

参数名类型必填说明
pageNumInteger是当前页码，最小值为1
pageSizeInteger是每页数量，最大值为1000
purchaseOrderCodeString否采购订单单号
purchaseDetailCodeString否采购明细单号
purchaseThemeString否采购主题
itemNameString否物料/商品名称
supplierNameString否供应商名称
createTimeBeginDate否创建时间开始时间
createTimeEndDate否创建时间结束时间
sortListList<FieldSortVO>否排序集合，详见FieldSortVO对象
fieldCodeString是属性编码
sortTypeInteger是排序类型

响应参数

参数名类型必填说明
codeString是响应码
messageString是响应消息
是采购订单列表pageNumInteger
是当前页码pageSizeInteger
是每页数量totalLong
是总记录数bizKeyLong
是业务IDpurchaseOrderDetailIdLong
是采购订单明细IDpurchaseOrderIdLong
是采购订单IDpurchaseOrderCodeString
是采购单号purchaseDetailCodeString
是采购明细单号purchaseThemeString
是采购主题purchaseSourceInteger
是采购来源purchaseSourceNameString
是采购来源名称sourceDetailCodeString
是关联单号totalPriceBigDecimal
是采购总价（不含税）totalHasTaxPriceBigDecimal
是采购总价（含税）unitPriceBigDecimal
是采购单价paymentAmountBigDecimal
是付款金额paymentProgressBigDecimal
是付款进度invoiceArrivalAmountBigDecimal
是到票金额invoiceArrivalProgressBigDecimal
是到票进度purchaseDetailStatusInteger
是采购明细状态purchaseDetailStatusNameString
是采购明细状态名称paymentStatusInteger
是支付状态paymentStatusNameString
是支付状态名称businessInvoiceArrivalStatusInteger
是到票状态businessInvoiceArrivalStatusNameString
是到票状态名称purchaseNumBigDecimal
是采购数量buyNumBigDecimal
是已下单数量notBuyNumBigDecimal
是未下单数量buildStockNumBigDecimal
是已生成入库数量inStockNumBigDecimal
是已入库数量returnOutStockNumBigDecimal
是采购退货数量stockNumBigDecimal
是库存数量materialIdLong
是物料IDgoodsIdLong
是商品IDitemIdLong
是物料/商品IDcategoryNameString
是物料/商品类别名称itemCodeString
是物料/商品编码mallNumberString
是自定义编号itemNameString
是物料/商品名称specificationString
是规格型号encapsulationString
是封装brandString
是品牌unitNameString
是单位名称unitValueString
是单位值supplierIdLong
是供应商IDsupplierSimpleNameString
是供应商简称supplierNameString
是供应商名称purchaseManagerIdLong
是采购负责人IDpurchaseManagerNameString
是采购负责人consigneeIdLong
是收货人IDconsigneeString
是收货人createByLong
是创建人IDcreateByNameString
是创建人requisitionUserIdLong
是请购人IDrequisitionUserNameString
是请购人名称associationProjectIdLong
是关联项目IDassociationProjectNameString
是关联项目名称emergencyLevelInteger
是紧急程度isEmergencyBoolean
是是否紧急expectedDeliveryDateDate
是期望到货日期createTimeDate
是创建时间inStockDateDate
是入库时间linkString
是链接remarkString
是备注expressCodeString
是快递单号expressTypeInteger
是快递类型expressTypeNameString
是快递类型名称expressProgressString
是快递进度recipientPhoneString
是收件人手机号recipientPhoneDesString
是收件人手机号DescustomFieldList<CustomFieldVO>
是materialPriceListList<MaterialPriceSimpleVO>是
fieldIdLong是自定义字段ID
fieldCodeString是自定义字段编码
fieldNameString是自定义字段名称
fieldTypeInteger是自定义字段类型
fieldValueString是自定义字段值
fieldOptionValueList<String>是自定义字段选项值
expressTypeInteger否快递类型
expressTypeNameString否快递类型名称
expressNoString否快递单号
expressPhoneString否手机号（脱敏）
expressPhoneDesString否手机号（加密）
projectIdLong否项目ID
projectaCodeString否项目编号
projectaNameString否项目名称
customFieldAttachmentListList<CustomFieldAttachmentVO>否附件列表
bizKeyLong是业务ID
priceTypeInteger是价格类型（1:物料移动加权平均单价）
priceStatusInteger是价格状态（1:未查询到立创物料，2:已查询到立创物料）
sourceIdLong是来源ID
sourceNameString是来源名称
taxRateBigDecimal是税率%
priceBigDecimal是物料价格（单位是物料基础单位）
priceDescString是价格描述
defaultFlagBoolean是是否默认（已废弃）
priceDefaultTypeListList<Integer>是价格默认类型列表
unitNameString是单位名称
unitValueString是单位值
{
 "pageNum": 1,
 "pageSize": 20,
 "purchaseOrderCode": "PO202601001",
 "itemName": "贴片电阻",
 "supplierName": "深圳供应商"
}{
 "code": "200",
 "message": "success",
 "data": {
 "pageNum": 1,
 "pageSize": 20,
 "total": 100,
 "data": [
 {
 "bizKey": 123456,
 "purchaseOrderCode": "PO202601001",
 "purchaseTheme": "电子元器件采购",
 "itemName": "贴片电阻",
 "supplierName": "深圳供应商",
 "purchaseNum": 1000,
 "unitPrice": 0.01,
 "totalPrice": 10000.00,
 "createTime": "2026-01-15 10:30:00"
 }
 ]
 }
}成功-
请求成功参数错误-请求参数不合法
未授权-未登录或token失效禁止访问
-无权限访问该接口服务器错误-

2. 查询采购订单详情

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

根据订单业务ID查询采购订单的详细信息

请求参数

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

响应参数

参数名类型必填说明
codeString是响应码
messageString是响应消息
是业务IDpurchaseOrderCodeString
是采购单号purchaseThemeString
是采购主题purchaseSourceInteger
是采购来源sourceIdLong
是采购来源IDsourceCodeString
是采购来源编码purchaseDetailRelationListList<PurchaseDetailRelationVO>
是采购关联信息列表bomSetsInteger
是BOM套数purchaseManagerIdLong
是采购负责人IDpurchaseManagerNameString
是采购负责人requisitionUserIdLong
是请购人IDrequisitionUserNameString
是请购人名称consigneeIdLong
是收货人IDconsigneeString
是收货人expectedDeliveryDateDate
是期望到货日期totalPriceBigDecimal
是采购总价purchaseDetailMaterialListList<PurchaseDetailItemRespVO>
是purchaseDetailGoodsListList<PurchaseGoodsDetailItemRespVO>是
bizKeyLong是明细业务ID
purchaseDetailCodeString是采购明细单号
purchaseDetailStatusInteger是采购明细状态
associationProjectIdLong是关联项目ID
associationProjectNameString是关联项目名称
purchaseDetailRelationListList<PurchaseDetailRelationVO>是采购关联信息
materialIdLong是物料ID
materialTypeInteger是物料类型
materialCategoryNameString是物料类别名称
materialCodeString是物料编码
materialNameString是物料名称
mallNumberString是商城编号
encapsulationString是封装
stitchString是针脚
brandString是品牌
specString是规格型号
supplierIdLong是供应商ID
supplierSimpleNameString是供应商简称
supplierNameString是供应商名称
expressCodeString是快递单号
expressTypeInteger是快递类型
expressTypeNameString是快递类型名称
recipientPhoneString是收件人手机号
recipientPhoneDesString是收件人手机号Des
purchaseNumBigDecimal是采购数量
buyNumBigDecimal是下单数量
needNumBigDecimal是需求数量
stockNumBigDecimal是库存数量
buildStockNumBigDecimal是已生成入库数量
inStockNumBigDecimal是入库数量
unitNameString是单位名称
unitValueString是单位值
unitPriceBigDecimal是采购单价
unitPriceDesString是采购单价Des
totalPriceBigDecimal是采购总价（不含税）
totalHasTaxPriceBigDecimal是采购总价（含税）
conversionCoefficientBigDecimal是单位换算系数
taxRateBigDecimal是税率%
taxAmountBigDecimal是税额
stockUnitNameString是库存单位名称
stockUnitValueString是库存单位值
substituteNumInteger是替换料数量
remarkString是备注
specificationString是规格型号
linkString是链接
requisitionUserIdLong是请购人ID
requisitionUserNameString是请购人名称
consigneeIdLong是收货人ID
consigneeString是收货人名称
expectedDeliveryDateDate是期望到货日期
emergencyLevelInteger是紧急程度
inStockDateDate是入库时间
firstUrlString是首张图片
customFieldList<CustomFieldVO>是自定义字段
materialPriceListList<MaterialPriceSimpleVO>是物料价格集合
locationNumListList<GoodsStockLocationNumVO>是库位详情
bizKeyLong是明细业务ID
purchaseDetailCodeString是采购明细单号
purchaseDetailStatusInteger是采购明细状态
associationProjectIdLong是关联项目ID
associationProjectNameString是关联项目名称
purchaseDetailRelationListList<PurchaseDetailRelationVO>是采购关联信息
goodsIdLong是商品ID
goodsCodeString是商品编码
goodsNameString是商品名称
productTypeInteger是产品属性
categoryNameString是商品分类名称
categoryValueString是商品分类值
brandString是品牌
specString是规格型号
supplierIdLong是供应商ID
supplierSimpleNameString是供应商简称
supplierNameString是供应商名称
expressCodeString是快递单号
expressTypeInteger是快递类型
expressTypeNameString是快递类型名称
recipientPhoneString是收件人手机号
recipientPhoneDesString是收件人手机号Des
purchaseNumBigDecimal是采购数量
buyNumBigDecimal是下单数量
needNumBigDecimal是需求数量
stockNumBigDecimal是库存数量
buildStockNumBigDecimal是已生成入库数量
inStockNumBigDecimal是入库数量
availableStockNumBigDecimal是可用库存数量
occupancyStockNumBigDecimal是占用库存数量
unitNameString是单位名称
unitValueString是单位值
unitPriceBigDecimal是采购单价
unitPriceDesString是采购单价Des
totalPriceBigDecimal是采购总价（不含税）
totalHasTaxPriceBigDecimal是采购总价（含税）
taxRateBigDecimal是税率%
taxAmountBigDecimal是税额
remarkString是备注
linkString是链接
requisitionUserIdLong是请购人ID
requisitionUserNameString是请购人名称
consigneeIdLong是收货人ID
consigneeString是收货人名称
expectedDeliveryDateDate是期望到货日期
emergencyLevelInteger是紧急程度
inStockDateDate是入库时间
firstUrlString是首张图片
customFieldList<CustomFieldVO>是自定义字段
locationNumListList<GoodsStockLocationNumVO>是库位详情
sourceIdLong是采购来源ID
sourceCodeString是采购来源code
sourceDetailIdLong是采购来源明细ID
sourceDetailCodeString是采购来源明细code
goodsIdLong是商品ID
warehouseIdLong是仓库ID
warehouseCodeString是仓库编码
warehouseNameString是仓库名称
belongShelfIdLong是所属货架ID
belongShelfString是所属货架
warehouseLocationIdLong是库位ID
warehouseLocationCodeString是库位编码
warehouseLocationNameString是库位名称
stockNumBigDecimal是库存数量
borrowNumBigDecimal是借调数量
fieldIdLong是自定义字段ID
fieldCodeString是自定义字段编码
fieldNameString是自定义字段名称
fieldTypeInteger是自定义字段类型
fieldValueString是自定义字段值
fieldOptionValueList<String>是自定义字段选项值
expressTypeInteger否快递类型
expressTypeNameString否快递类型名称
expressNoString否快递单号
expressPhoneString否手机号（脱敏）
expressPhoneDesString否手机号（加密）
projectIdLong否项目ID
projectaCodeString否项目编号
projectaNameString否项目名称
customFieldAttachmentListList<CustomFieldAttachmentVO>否附件列表
bizKeyLong是业务ID
priceTypeInteger是价格类型（1:物料移动加权平均单价）
priceStatusInteger是价格状态（1:未查询到立创物料，2:已查询到立创物料）
sourceIdLong是来源ID
sourceNameString是来源名称
taxRateBigDecimal是税率%
priceBigDecimal是物料价格（单位是物料基础单位）
priceDescString是价格描述
defaultFlagBoolean是是否默认（已废弃）
priceDefaultTypeListList<Integer>是价格默认类型列表
unitNameString是单位名称
unitValueString是单位值
fieldAccessIdString是附件访问ID
fieldAccessNameString是附件访问名称
{
 "bizKey": 123456
}{
 "code": "200",
 "message": "success",
 "data": {
 "bizKey": 123456,
 "purchaseOrderCode": "PO202601001",
 "purchaseTheme": "电子元器件采购",
 "purchaseSource": 1,
 "sourceId": 1001,
 "sourceCode": "SRC001",
 "purchaseDetailRelationList": [
 {
 "sourceId": 1001,
 "sourceCode": "SRC001",
 "sourceDetailId": 2001,
 "sourceDetailCode": "SRCD001"
 }
 ],
 "bomSets": 10,
 "purchaseManagerId": 10001,
 "purchaseManagerName": "张三",
 "requisitionUserId": 10002,
 "requisitionUserName": "李四",
 "consigneeId": 10003,
 "consignee": "王五",
 "expectedDeliveryDate": "2026-01-25 00:00:00",
 "totalPrice": 10000.00,
 "purchaseDetailMaterialList": [
 {
 "bizKey": 200001,
 "purchaseDetailCode": "POD202601001-001",
 "purchaseDetailStatus": 2,
 "associationProjectId": 3001,
 "associationProjectName": "项目A",
 "purchaseDetailRelationList": [],
 "materialId": 4001,
 "materialType": 1,
 "materialCategoryName": "电阻",
 "materialCode": "RES-0805-10K",
 "materialName": "贴片电阻",
 "mallNumber": "MALL001",
 "encapsulation": "0805",
 "stitch": "2",
 "brand": "国巨",
 "spec": "0805 10K 1%",
 "supplierId": 5001,
 "supplierSimpleName": "深圳供应商",
 "supplierName": "深圳市XX电子有限公司",
 "expressCode": "SF1234567890",
 "expressType": 1,
 "expressTypeName": "顺丰速运",
 "recipientPhone": "138****5678",
 "recipientPhoneDes": "encrypted_data",
 "purchaseNum": 1000,
 "buyNum": 1000,
 "needNum": 1000,
 "stockNum": 5000,
 "buildStockNum": 800,
 "inStockNum": 750,
 "unitName": "个",
 "unitValue": "pcs",
 "unitPrice": 0.01,
 "unitPriceDes": "0.01",
 "totalPrice": 10.00,
 "totalHasTaxPrice": 11.30,
 "conversionCoefficient": 1.0,
 "taxRate": 13.00,
 "taxAmount": 1.30,
 "stockUnitName": "个",
 "stockUnitValue": "pcs",
 "substituteNum": 0,
 "remark": "备注信息",
 "specification": "0805 10K 1%",
 "link": "https://example.com/product/123",
 "requisitionUserId": 10002,
 "requisitionUserName": "李四",
 "consigneeId": 10003,
 "consignee": "王五",
 "expectedDeliveryDate": "2026-01-25 00:00:00",
 "emergencyLevel": 1,
 "inStockDate": "2026-01-20 14:30:00",
 "firstUrl": "https://example.com/image.jpg",
 "customField": [],
 "materialPriceList": [],
 "locationNumList": [
 {
 "goodsId": 4001,
 "warehouseId": 6001,
 "warehouseCode": "WH001",
 "warehouseName": "主仓库",
 "belongShelfId": 7001,
 "belongShelf": "A区货架",
 "warehouseLocationId": 8001,
 "warehouseLocationCode": "A-01-01",
 "warehouseLocationName": "A区1排1列",
 "stockNum": 5000,
 "borrowNum": 0
 }
 ]
 }
 ],
 "purchaseDetailGoodsList": [
 {
 "bizKey": 300001,
 "purchaseDetailCode": "POD202601001-002",
 "purchaseDetailStatus": 2,
 "associationProjectId": 3001,
 "associationProjectName": "项目A",
 "purchaseDetailRelationList": [],
 "goodsId": 9001,
 "goodsCode": "GOODS001",
 "goodsName": "成品A",
 "productType": 1,
 "categoryName": "电子产品",
 "categoryValue": "electronics",
 "brand": "品牌A",
 "spec": "规格A",
 "supplierId": 5001,
 "supplierSimpleName": "深圳供应商",
 "supplierName": "深圳市XX电子有限公司",
 "expressCode": "SF1234567891",
 "expressType": 1,
 "expressTypeName": "顺丰速运",
 "recipientPhone": "138****5678",
 "recipientPhoneDes": "encrypted_data",
 "purchaseNum": 100,
 "buyNum": 100,
 "needNum": 100,
 "stockNum": 500,
 "buildStockNum": 80,
 "inStockNum": 75,
 "availableStockNum": 450,
 "occupancyStockNum": 50,
 "unitName": "台",
 "unitValue": "unit",
 "unitPrice": 100.00,
 "unitPriceDes": "100.00",
 "totalPrice": 10000.00,
 "totalHasTaxPrice": 11300.00,
 "taxRate": 13.00,
 "taxAmount": 1300.00,
 "remark": "备注信息",
 "link": "https://example.com/product/456",
 "requisitionUserId": 10002,
 "requisitionUserName": "李四",
 "consigneeId": 10003,
 "consignee": "王五",
 "expectedDeliveryDate": "2026-01-25 00:00:00",
 "emergencyLevel": 1,
 "inStockDate": "2026-01-20 14:30:00",
 "firstUrl": "https://example.com/image2.jpg",
 "customField": [],
 "locationNumList": []
 }
 ]
 }
}成功-
请求成功参数错误-请求参数不合法
未授权-未登录或token失效禁止访问
-无权限访问该接口服务器错误-
© 嘉立创云ERP帮助中心 ｜ 本文档以客户视角编写，内容持续更新