# BOM API

# bom查询

接口地址:/api/open/v2/boms/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "conditions": [
      {
        "bomVersion": "SYSTEM-DEFAULT",
        "itemCode": "HC-1001"
      }
    ]
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
requestParameter	requestParameter	body	true	RequestParameter«BomQueryListParam»	RequestParameter«BomQueryListParam»
body			false	BomQueryListParam	BomQueryListParam
conditions	查询条件		false	array	BomQueryParam
bomVersion	bom版本号		false	string
itemCode	物料编码		false	string

响应状态:

状态码	说明	schema
200	OK	ListResponse«BomQueryListDTO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		ListResponseData«BomQueryListDTO»	ListResponseData«BomQueryListDTO»
list		array	BomQueryListDTO
bomComponents	BOM组件	array	BomComponent
attritionRate	损耗率	number
bottom	是否底层,可用值:ON,OFF	string
componentItem	BOM组件物料	ItemSimpleDTO	ItemSimpleDTO
category	分类	string
code	物料编号	string
itemSpecs	物料规格	array	ItemSpec
specName	规格名称	string
specValue	规格值	string
itemUnit	物料单位信息	ItemUnit	ItemUnit
baseToInventoryQuantity	基本-库存	number
baseToProductionQuantity	基本-生产	number
baseToPurchaseQuantity	基本-采购	number
baseToSaleQuantity	基本-销售	number
baseUnit	基本单位	string
inventoryToBaseQuantity	库存-基本	number
inventoryUnit	库存单位	string
jbkToProductionQuantity	报工-生产	number
jbkUnit	报工单位	string
productionToBaseQuantity	生产-基本	number
productionToJbkQuantity	生产-报工	number
productionUnit	生产单位	string
purchaseToBaseQuantity	采购-基本	number
purchaseUnit	采购单位	string
saleToBaseQuantity	销售-基本	number
saleUnit	销售单位	string
name	物料名称	string
type	属性	string
componentRateQty	使用量	number
parentRateQty	上层基础数量	number
bomVersion	BOM版本	string
parentItem	BOM父级物料	ItemSimpleDTO	ItemSimpleDTO
category	分类	string
code	物料编号	string
itemSpecs	物料规格	array	ItemSpec
specName	规格名称	string
specValue	规格值	string
itemUnit	物料单位信息	ItemUnit	ItemUnit
baseToInventoryQuantity	基本-库存	number
baseToProductionQuantity	基本-生产	number
baseToPurchaseQuantity	基本-采购	number
baseToSaleQuantity	基本-销售	number
baseUnit	基本单位	string
inventoryToBaseQuantity	库存-基本	number
inventoryUnit	库存单位	string
jbkToProductionQuantity	报工-生产	number
jbkUnit	报工单位	string
productionToBaseQuantity	生产-基本	number
productionToJbkQuantity	生产-报工	number
productionUnit	生产单位	string
purchaseToBaseQuantity	采购-基本	number
purchaseUnit	采购单位	string
saleToBaseQuantity	销售-基本	number
saleUnit	销售单位	string
name	物料名称	string
type	属性	string
message		string

响应示例:

{
	"code": 0,
	"data": {
		"list": [
			{
				"bomComponents": [
					{
						"attritionRate": 0,
						"bottom": "",
						"componentItem": {
							"category": "",
							"code": "",
							"itemSpecs": [
								{
									"specName": "",
									"specValue": ""
								}
							],
							"itemUnit": {
								"baseToInventoryQuantity": 0,
								"baseToProductionQuantity": 0,
								"baseToPurchaseQuantity": 0,
								"baseToSaleQuantity": 0,
								"baseUnit": "",
								"inventoryToBaseQuantity": 0,
								"inventoryUnit": "",
								"jbkToProductionQuantity": 0,
								"jbkUnit": "",
								"productionToBaseQuantity": 0,
								"productionToJbkQuantity": 0,
								"productionUnit": "",
								"purchaseToBaseQuantity": 0,
								"purchaseUnit": "",
								"saleToBaseQuantity": 0,
								"saleUnit": ""
							},
							"name": "",
							"type": ""
						},
						"componentRateQty": 0,
						"parentRateQty": 0
					}
				],
				"bomVersion": "",
				"parentItem": {}
			}
		]
	},
	"message": ""
}

# Sync BOM

接口地址:/api/open/v2/boms/sync

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "bomComponents": [
  {
    "index": 1,
    "parentIndex": 0,
    "code": "PRD-001",
    "quantity": 1
  },
  {
    "index": 2,
    "parentIndex": 1,
    "code": "WC-OO1",
    "quantity": 1
  },
  {
    "index": 3,
    "parentIndex": 1,
    "code": "GC-OO1",
    "quantity": 4
  },
  {
    "index": 4,
    "parentIndex": 2,
    "code": "ir-304",
    "quantity": 3
  },
  {
    "index": 5,
    "parentIndex": 3,
    "code": "ir-304",
    "quantity": 2
  }
],
    "comments": "这个是 BOM 备注"
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
bomSaveParamRequestParameter	bomSaveParamRequestParameter	body	true	RequestParameter«BomSaveParam»	RequestParameter«BomSaveParam»
body			false	BomSaveParam	BomSaveParam
bomComponents	BOM 节点信息		false	array	BomParam
attritionRate	损耗率		false	number
bomVersion	bom版本		false	string
code	BOM节点物料编码		false	string
index	BOM节点ID, index 由调用者自定义， index 必须大于等于 1		false	integer
isTrusteeItem	是否为受托物料		false	boolean
parentIndex	BOM节点父节点ID,当 parentIndex 为 0 的时候。为根节点。一次请求有且仅能有一个 parentIndex 为 0 的节点		false	integer
quantity	BOM节点需求数字		false	number
syncRouting	是否更新工艺路线		false	boolean
tags	BOM节点标签		false	array	string
comments	备注		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# bom删除

接口地址:/api/open/v2/boms/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": []
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
requestParameter	requestParameter	body	true	RequestParameter«Set«string»»	RequestParameter«Set«string»»
body			false	array	string

响应状态:

状态码	说明	schema
200	OK	ListResponse«BomMessageDTO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		ListResponseData«BomMessageDTO»	ListResponseData«BomMessageDTO»
list		array	BomMessageDTO
bomVersion	版本号	string
isConfirm	是否需要重新确认	boolean
isSuccess	是否成功	boolean
itemCode	物料编码	string
message	错误信息	string
message		string

响应示例:

{
	"code": 0,
	"data": {
		"list": [
			{
				"bomVersion": "",
				"isConfirm": true,
				"isSuccess": true,
				"itemCode": "",
				"message": ""
			}
		]
	},
	"message": ""
}

← 物料-分类API 客户-分类API →