# 物料-分类API

# 创建物料分类

接口地址:/api/open/v2/item/categories/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "IRON_001",
    "inventoryAccountTypeEnum": "",
    "inventoryCycle": 90,
    "name": "五金件",
    "parentCode": "Mat_101"
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
itemCategorySaveParamRequestParameter itemCategorySaveParamRequestParameter body true RequestParameter«ItemCategorySaveParam» RequestParameter«ItemCategorySaveParam»
  body false ItemCategorySaveParam ItemCategorySaveParam
    code 编码 false string
    inventoryAccountTypeEnum 存货计价方式(【DEFAULT】:,【WEIGHTED】:加权平均法,【SPECIFIC】:个别计价法),可用值:WEIGHTED false string
    inventoryCycle 库存周转期限,单位:天 false integer
    name 名称 false string
    parentCode 父级分类,如无则为空 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": ""
}

# 修改物料分类详情

接口地址:/api/open/v2/item/categories/createOrUpdate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "IRON_001",
    "inventoryAccountTypeEnum": "",
    "inventoryCycle": 90,
    "name": "五金件",
    "parentCode": "Mat_101"
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
itemCategorySaveParamRequestParameter itemCategorySaveParamRequestParameter body true RequestParameter«ItemCategorySaveParam» RequestParameter«ItemCategorySaveParam»
  body false ItemCategorySaveParam ItemCategorySaveParam
    code 编码 false string
    inventoryAccountTypeEnum 存货计价方式(【DEFAULT】:,【WEIGHTED】:加权平均法,【SPECIFIC】:个别计价法),可用值:WEIGHTED false string
    inventoryCycle 库存周转期限,单位:天 false integer
    name 名称 false string
    parentCode 父级分类,如无则为空 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": ""
}

# 删除物料分类

接口地址:/api/open/v2/item/categories/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
codeReq codeReq body true RequestParameter«string» RequestParameter«string»
  body 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": ""
}

# 查询物料分类列表

接口地址:/api/open/v2/item/categories/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "",
    "codeLike": "",
    "codes": [],
    "name": "",
    "nameLike": "",
    "names": [],
    "pagingParam": {
      "length": 0,
      "start": 0
    },
    "parentCode": ""
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
queryParamRequestParameter queryParamRequestParameter body true RequestParameter«ItemCategoryQueryParam» RequestParameter«ItemCategoryQueryParam»
  body false ItemCategoryQueryParam ItemCategoryQueryParam
    code 编码完全匹配 false string
    codeLike 编码模糊匹配 false string
    codes 分类code false array string
    name 名称完全匹配 false string
    nameLike 名称模糊匹配 false string
    names 分类名称 false array string
    pagingParam false PagingParam PagingParam
      length false integer
      start false integer
    parentCode 匹配父级分类 false string

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data ListPagingResponseData«ItemCategoryDTO» ListPagingResponseData«ItemCategoryDTO»
  length integer(int32)
  list array ItemCategoryDTO
    code 编码 string
    inventoryCycle 库存周转期限,单位:天 integer
    name 名称 string
    parentCode 父级分类编码,如无则为空 string
    parentName 父级分类名称,如无则为空 string
  recordsTotal integer(int32)
  start integer(int32)
message string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [
			{
				"code": "IRON_001",
				"inventoryCycle": 90,
				"name": "五金件",
				"parentCode": "Mat_101",
				"parentName": "成品"
			}
		],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

# 修改物料分类详情

接口地址:/api/open/v2/item/categories/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "IRON_001",
    "inventoryAccountTypeEnum": "",
    "inventoryCycle": 90,
    "name": "五金件",
    "parentCode": "Mat_101"
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
itemCategorySaveParamRequestParameter itemCategorySaveParamRequestParameter body true RequestParameter«ItemCategorySaveParam» RequestParameter«ItemCategorySaveParam»
  body false ItemCategorySaveParam ItemCategorySaveParam
    code 编码 false string
    inventoryAccountTypeEnum 存货计价方式(【DEFAULT】:,【WEIGHTED】:加权平均法,【SPECIFIC】:个别计价法),可用值:WEIGHTED false string
    inventoryCycle 库存周转期限,单位:天 false integer
    name 名称 false string
    parentCode 父级分类,如无则为空 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": ""
}

# 物料 API

# 修改物料规格-(只能新增修改不能删除)

接口地址:/api/open/v2/items/attributes/upsert

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "attributes": [
      {
        "code": "",
        "key": "颜色",
        "value": "新核云蓝"
      }
    ],
    "code": ""
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
attributesParam attributesParam body true RequestParameter«AttributesSaveParam» RequestParameter«AttributesSaveParam»
  body false AttributesSaveParam AttributesSaveParam
    attributes 规格属性,最多 5 条 false array Spec
      code false string
      key 属性名 true string
      value 属性值 true string
    code 编码 true 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": ""
}

# 审核物料

接口地址:/api/open/v2/items/audit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "itemCode": "",
    "result": ""
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
requestParameter requestParameter body true RequestParameter«ItemAuditByCodeParam» RequestParameter«ItemAuditByCodeParam»
  body false ItemAuditByCodeParam ItemAuditByCodeParam
    itemCode 物料编号 false string
    result 审核结果 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": ""
}

# 修改基础属性

接口地址:/api/open/v2/items/base/upsert

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "allowProduction": 0,
    "allowPurchase": 0,
    "allowSale": 0,
    "attributes": [
      {
        "code": "",
        "key": "颜色",
        "value": "新核云蓝"
      }
    ],
    "auditStatus": "",
    "categoryCode": "",
    "code": "",
    "inventoryAttributes": {
      "abcCategory": 0,
      "cost": 0,
      "defaultWarehouseCode": "",
      "defaultWarehouseLocation": "",
      "enableInteger": 0,
      "integerWay": 0,
      "maxInventory": 0,
      "minInventory": 0,
      "minPackQuantity": 0,
      "rePurchasePoint": 0,
      "realCostPrice": 0,
      "safetyInventory": 0,
      "shelfLife": 0,
      "snType": "",
      "useBatch": 0,
      "useKey": 0,
      "useLockInventory": 0,
      "useOverdueMessage": 0,
      "useSN": 0,
      "useSafetyInventory": 0
    },
    "itemAssistUnits": [
      {
        "assistToBaseRatioVal": 0,
        "baseToAssistRatioVal": 0,
        "unitCode": ""
      }
    ],
    "itemCustomizeFields": {},
    "name": "",
    "status": "",
    "type": "",
    "unit": ""
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
saveParamRequestParameter saveParamRequestParameter body true RequestParameter«BaseItemSaveParam» RequestParameter«BaseItemSaveParam»
  body false BaseItemSaveParam BaseItemSaveParam
    allowProduction 允许生产 false integer
    allowPurchase 允许采购 false integer
    allowSale 允许销售 false integer
    attributes 规格属性,最多 5 条 false array Spec
      code false string
      key 属性名 true string
      value 属性值 true string
    auditStatus 物料审核状态(【TO_BE_SUBMIT】:待提交,【AUDITING】:审核中,【AUDITED】:已审核),可用值:TO_BE_SUBMIT,AUDITING,AUDITED false string
    categoryCode 物料分类编码 true string
    code 物料编码 true string
    inventoryAttributes 库存属性 false InventoryAttributes InventoryAttributes
      abcCategory ABC类,可用值:0,1,2,3 false integer
      cost 参考成本 false number
      defaultWarehouseCode 默认仓库编码 false string
      defaultWarehouseLocation 默认库位编码 false string
      enableInteger 是否开启取整 0:关闭 1:开启(【1】:是,【0】:否) false integer
      integerWay 取整方式 0:向上取整 1:向下取整 2:四舍五入(【0】:向上取整,【1】:向下取整,【2】:四舍五入) false integer
      maxInventory 最大库存 false number
      minInventory 最小库存 false number
      minPackQuantity 存货最小包装 false number
      rePurchasePoint 再订货点 false number
      realCostPrice 实际成本 false number
      safetyInventory 安全库存 false number
      shelfLife 保质期,单位:天 false integer
      snType 是否开启序列号管理 CATEGORY 上级规则:分类、CURRENT 当前规则(【CATEGORY】:上级规则:分类,【CURRENT】:当前规则),可用值:CATEGORY,CURRENT false string
      useBatch 是否开启批次&计划 false integer
      useKey 是否关键(【1】:是,【0】:否) false integer
      useLockInventory 是否启用锁库 false integer
      useOverdueMessage 是否开启逾期消息提醒(【1】:是,【0】:否) false integer
      useSN 是否开启序列号管理(【1】:是,【0】:否) false integer
      useSafetyInventory 是否开启安全库存 false integer
    itemAssistUnits 辅助单位 false array ItemAssistUnitParam
      assistToBaseRatioVal 辅助-基本,辅助单位个数 false number
      baseToAssistRatioVal 基本-辅助,基本单位个数 false number
      unitCode 辅助单位 false string
    itemCustomizeFields 自定义字段 false object
    name 名称 true string
    status 物料状态(【DISABLED】:已禁用,【ENABLE】:已启用,【TO_BE_DISABLED】:待禁用,【TO_BE_ENABLE】:待启用),可用值:DISABLED,ENABLE,TO_BE_DISABLED,TO_BE_ENABLE false string
    type 物料类型,可用值:products,semi_products,materials true string
    unit 单位 true 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": ""
}

# 批量创建物料

接口地址:/api/open/v2/items/batch/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": [
    {
      "allowOutsource": 0,
      "allowProduction": 0,
      "allowPurchase": 0,
      "allowSale": 0,
      "attributes": [
        {
          "code": "",
          "key": "颜色",
          "value": "新核云蓝"
        }
      ],
      "auditStatus": "",
      "categoryCode": "",
      "code": "",
      "inventoryAttributes": {
        "abcCategory": 0,
        "cost": 0,
        "defaultWarehouseCode": "",
        "defaultWarehouseLocation": "",
        "enableInteger": 0,
        "integerWay": 0,
        "maxInventory": 0,
        "minInventory": 0,
        "minPackQuantity": 0,
        "rePurchasePoint": 0,
        "realCostPrice": 0,
        "safetyInventory": 0,
        "shelfLife": 0,
        "snType": "",
        "useBatch": 0,
        "useKey": 0,
        "useLockInventory": 0,
        "useOverdueMessage": 0,
        "useSN": 0,
        "useSafetyInventory": 0
      },
      "itemAssistUnits": [
        {
          "assistToBaseRatioVal": 0,
          "baseToAssistRatioVal": 0,
          "unitCode": ""
        }
      ],
      "itemAttachmentAttributes": {
        "attachments": [
          {
            "name": "",
            "size": 0,
            "type": "",
            "url": ""
          }
        ],
        "blueprints": [
          {
            "name": "",
            "size": 0,
            "type": "",
            "url": ""
          }
        ],
        "comments": ""
      },
      "itemCustomizeFields": {},
      "itemQualityInspectionAttributes": {
        "procurementInspectionScheme": "",
        "procurementInspectionStandard": "",
        "useProcurementInspection": 0
      },
      "itemSpecificationConfigParams": [
        {
          "key": "",
          "valueSet": [],
          "valuesFrom": 0
        }
      ],
      "itemSupplyChainAttributes": {
        "isConfigurable": 0,
        "overDeliveryRate": 0,
        "overReceiveRate": 0,
        "procurementPrice": 0,
        "procurementPriceType": 0,
        "procurementTax": 0,
        "salePrice": 0,
        "salePriceType": 0,
        "saleTax": 0
      },
      "itemUnit": {
        "inventoryUnit": "",
        "jbkUnit": "",
        "productionUnit": "",
        "purchaseUnit": "",
        "saleUnit": ""
      },
      "itemUnitParam": {
        "baseToInventoryQuantity": 0,
        "baseToProductionQuantity": 0,
        "baseToPurchaseQuantity": 0,
        "baseToSaleQuantity": 0,
        "baseUnitName": "",
        "inventoryToBaseQuantity": 0,
        "inventoryUnitName": "",
        "jbkToProductionQuantity": 0,
        "jbkUnitName": "",
        "productionToBaseQuantity": 0,
        "productionToJbkQuantity": 0,
        "productionUnitName": "",
        "purchaseToBaseQuantity": 0,
        "purchaseUnitName": "",
        "saleToBaseQuantity": 0,
        "saleUnitName": ""
      },
      "manufactureAttributes": {
        "batchSize": 0,
        "dailyProduction": 0,
        "defectiveRate": 0,
        "incrementSize": 0,
        "planBatchSize": 0,
        "planStrategy": 0
      },
      "name": "",
      "status": "",
      "type": "",
      "unit": "",
      "updateItemSpecificationConfig": true
    }
  ]
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
itemSaveParamRequestParameter itemSaveParamRequestParameter body true RequestParameter«List«ItemSaveParam»» RequestParameter«List«ItemSaveParam»»
  body false array ItemSaveParam
    allowOutsource 允许委外 false integer
    allowProduction 允许生产 false integer
    allowPurchase 允许采购 false integer
    allowSale 允许销售 false integer
    attributes 规格属性,最多 5 条 false array Spec
      code false string
      key 属性名 true string
      value 属性值 true string
    auditStatus 物料审核状态(【TO_BE_SUBMIT】:待提交,【AUDITING】:审核中,【AUDITED】:已审核),可用值:TO_BE_SUBMIT,AUDITING,AUDITED false string
    categoryCode 物料分类编码 true string
    code 物料编码 true string
    inventoryAttributes 库存属性 false InventoryAttributes InventoryAttributes
      abcCategory ABC类,可用值:0,1,2,3 false integer
      cost 参考成本 false number
      defaultWarehouseCode 默认仓库编码 false string
      defaultWarehouseLocation 默认库位编码 false string
      enableInteger 是否开启取整 0:关闭 1:开启(【1】:是,【0】:否) false integer
      integerWay 取整方式 0:向上取整 1:向下取整 2:四舍五入(【0】:向上取整,【1】:向下取整,【2】:四舍五入) false integer
      maxInventory 最大库存 false number
      minInventory 最小库存 false number
      minPackQuantity 存货最小包装 false number
      rePurchasePoint 再订货点 false number
      realCostPrice 实际成本 false number
      safetyInventory 安全库存 false number
      shelfLife 保质期,单位:天 false integer
      snType 是否开启序列号管理 CATEGORY 上级规则:分类、CURRENT 当前规则(【CATEGORY】:上级规则:分类,【CURRENT】:当前规则),可用值:CATEGORY,CURRENT false string
      useBatch 是否开启批次&计划 false integer
      useKey 是否关键(【1】:是,【0】:否) false integer
      useLockInventory 是否启用锁库 false integer
      useOverdueMessage 是否开启逾期消息提醒(【1】:是,【0】:否) false integer
      useSN 是否开启序列号管理(【1】:是,【0】:否) false integer
      useSafetyInventory 是否开启安全库存 false integer
    itemAssistUnits 辅助单位 false array ItemAssistUnitParam
      assistToBaseRatioVal 辅助-基本,辅助单位个数 false number
      baseToAssistRatioVal 基本-辅助,基本单位个数 false number
      unitCode 辅助单位 false string
    itemAttachmentAttributes 物料附件属性 false ItemAttachmentAttributes ItemAttachmentAttributes
      attachments 附件信息 false array AttachmentParam
        name false string
        size false integer
        type false string
        url false string
      blueprints 设计图 false array AttachmentParam
        name false string
        size false integer
        type false string
        url false string
      comments 备注 false string
    itemCustomizeFields 自定义字段 false object
    itemQualityInspectionAttributes 采购收货检验属性 false ItemQualityInspectionAttributes ItemQualityInspectionAttributes
      procurementInspectionScheme 检验方案 false string
      procurementInspectionStandard 检验规范 false string
      useProcurementInspection 是否启用来料检验,注意区分生产检验 false integer
    itemSpecificationConfigParams 可配置规格 false array ItemSpecificationConfigParam
      key 可配置规格 false string
      valueSet 规格值集合 false array string
      valuesFrom 规格来源(【0】:自定义,【1】:规格库) false integer
    itemSupplyChainAttributes 供应链属性 false ItemSupplyChainAttributes ItemSupplyChainAttributes
      isConfigurable 可配置(【1】:是,【0】:否) false integer
      overDeliveryRate 销售超额发货比例 false number
      overReceiveRate 超额收货比例 false number
      procurementPrice 采购价 false number
      procurementPriceType 采购单价类型(【1】:含税,【2】:不含税) false integer
      procurementTax 采购税率 false number
      salePrice 销售市场价 false number
      salePriceType 销售单价类型(【1】:含税,【2】:不含税) false integer
      saleTax 销售税率 false number
    itemUnit 多单位属性 false ItemUnit ItemUnit
      inventoryUnit 库存单位 false string
      jbkUnit 报工单位 false string
      productionUnit 生产单位 false string
      purchaseUnit 采购单位 false string
      saleUnit 销售单位 false string
    itemUnitParam 物料单位 false ItemUnitParam ItemUnitParam
      baseToInventoryQuantity 基本-库存 false number
      baseToProductionQuantity 基本-生产 false number
      baseToPurchaseQuantity 基本-采购 false number
      baseToSaleQuantity 基本-销售 false number
      baseUnitName 基本单位 false string
      inventoryToBaseQuantity 库存-基本 false number
      inventoryUnitName 库存单位 false string
      jbkToProductionQuantity 报工-生产 false number
      jbkUnitName 报工单位 false string
      productionToBaseQuantity 生产-基本呢 false number
      productionToJbkQuantity 生产-报工 false number
      productionUnitName 生产单位 false string
      purchaseToBaseQuantity 采购-基本 false number
      purchaseUnitName 采购单位 false string
      saleToBaseQuantity 销售-基本 false number
      saleUnitName 销售单位 false string
    manufactureAttributes 计划&生产属性 false ManufactureAttributes ManufactureAttributes
      batchSize 流转批量大小 false number
      dailyProduction 日产能 false number
      defectiveRate 次品率 false number
      incrementSize 增量大小 false number
      planBatchSize 计划批量大小 false number
      planStrategy 计划策略,可用值:1,2 false integer
    name 名称 true string
    status 物料状态(【DISABLED】:已禁用,【ENABLE】:已启用,【TO_BE_DISABLED】:待禁用,【TO_BE_ENABLE】:待启用),可用值:DISABLED,ENABLE,TO_BE_DISABLED,TO_BE_ENABLE false string
    type 物料类型,可用值:products,semi_products,materials true string
    unit 单位 true string
    updateItemSpecificationConfig 是否更新配置属性项,默认false false boolean

响应状态:

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

响应参数:

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

响应示例:

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

# 物料图纸信息上传

接口地址:/api/open/v2/items/blueprint/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "blueprints": [
      {
        "key": "",
        "name": "",
        "size": "",
        "type": "",
        "url": ""
      }
    ],
    "code": ""
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
itemBluePrintUpdateParamRequestParameter itemBluePrintUpdateParamRequestParameter body true RequestParameter«ItemBluePrintUpdateParam» RequestParameter«ItemBluePrintUpdateParam»
  body false ItemBluePrintUpdateParam ItemBluePrintUpdateParam
    blueprints false array BluePrintFileParam
      key 存储的key false string
      name 文件名 false string
      size 文件大小 false string
      type 文件类型 false string
      url 文件路径,上传文件返回值 false string
    code 物料编码 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": ""
}

# 查询物料编码集合

接口地址:/api/open/v2/items/codes/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {}
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
queryParamRequestParameter queryParamRequestParameter body true RequestParameter«ItemQueryParam» RequestParameter«ItemQueryParam»
  body false ItemQueryParam ItemQueryParam

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data ListPagingResponseData«string» ListPagingResponseData«string»
  length integer(int32)
  list array string
  recordsTotal integer(int32)
  start integer(int32)
message string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

# 创建物料

接口地址:/api/open/v2/items/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "allowOutsource": 0,
    "allowProduction": 0,
    "allowPurchase": 0,
    "allowSale": 0,
    "attributes": [
      {
        "code": "",
        "key": "颜色",
        "value": "新核云蓝"
      }
    ],
    "auditStatus": "",
    "categoryCode": "",
    "code": "",
    "inventoryAttributes": {
      "abcCategory": 0,
      "cost": 0,
      "defaultWarehouseCode": "",
      "defaultWarehouseLocation": "",
      "enableInteger": 0,
      "integerWay": 0,
      "maxInventory": 0,
      "minInventory": 0,
      "minPackQuantity": 0,
      "rePurchasePoint": 0,
      "realCostPrice": 0,
      "safetyInventory": 0,
      "shelfLife": 0,
      "snType": "",
      "useBatch": 0,
      "useKey": 0,
      "useLockInventory": 0,
      "useOverdueMessage": 0,
      "useSN": 0,
      "useSafetyInventory": 0
    },
    "itemAssistUnits": [
      {
        "assistToBaseRatioVal": 0,
        "baseToAssistRatioVal": 0,
        "unitCode": ""
      }
    ],
    "itemAttachmentAttributes": {
      "attachments": [
        {
          "name": "",
          "size": 0,
          "type": "",
          "url": ""
        }
      ],
      "blueprints": [
        {
          "name": "",
          "size": 0,
          "type": "",
          "url": ""
        }
      ],
      "comments": ""
    },
    "itemCustomizeFields": {},
    "itemQualityInspectionAttributes": {
      "procurementInspectionScheme": "",
      "procurementInspectionStandard": "",
      "useProcurementInspection": 0
    },
    "itemSpecificationConfigParams": [
      {
        "key": "",
        "valueSet": [],
        "valuesFrom": 0
      }
    ],
    "itemSupplyChainAttributes": {
      "isConfigurable": 0,
      "overDeliveryRate": 0,
      "overReceiveRate": 0,
      "procurementPrice": 0,
      "procurementPriceType": 0,
      "procurementTax": 0,
      "salePrice": 0,
      "salePriceType": 0,
      "saleTax": 0
    },
    "itemUnit": {
      "inventoryUnit": "",
      "jbkUnit": "",
      "productionUnit": "",
      "purchaseUnit": "",
      "saleUnit": ""
    },
    "itemUnitParam": {
      "baseToInventoryQuantity": 0,
      "baseToProductionQuantity": 0,
      "baseToPurchaseQuantity": 0,
      "baseToSaleQuantity": 0,
      "baseUnitName": "",
      "inventoryToBaseQuantity": 0,
      "inventoryUnitName": "",
      "jbkToProductionQuantity": 0,
      "jbkUnitName": "",
      "productionToBaseQuantity": 0,
      "productionToJbkQuantity": 0,
      "productionUnitName": "",
      "purchaseToBaseQuantity": 0,
      "purchaseUnitName": "",
      "saleToBaseQuantity": 0,
      "saleUnitName": ""
    },
    "manufactureAttributes": {
      "batchSize": 0,
      "dailyProduction": 0,
      "defectiveRate": 0,
      "incrementSize": 0,
      "planBatchSize": 0,
      "planStrategy": 0
    },
    "name": "",
    "status": "",
    "type": "",
    "unit": "",
    "updateItemSpecificationConfig": true
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
itemSaveParamRequestParameter itemSaveParamRequestParameter body true RequestParameter«ItemSaveParam» RequestParameter«ItemSaveParam»
  body false ItemSaveParam ItemSaveParam
    allowOutsource 允许委外 false integer
    allowProduction 允许生产 false integer
    allowPurchase 允许采购 false integer
    allowSale 允许销售 false integer
    attributes 规格属性,最多 5 条 false array Spec
      code false string
      key 属性名 true string
      value 属性值 true string
    auditStatus 物料审核状态(【TO_BE_SUBMIT】:待提交,【AUDITING】:审核中,【AUDITED】:已审核),可用值:TO_BE_SUBMIT,AUDITING,AUDITED false string
    categoryCode 物料分类编码 true string
    code 物料编码 true string
    inventoryAttributes 库存属性 false InventoryAttributes InventoryAttributes
      abcCategory ABC类,可用值:0,1,2,3 false integer
      cost 参考成本 false number
      defaultWarehouseCode 默认仓库编码 false string
      defaultWarehouseLocation 默认库位编码 false string
      enableInteger 是否开启取整 0:关闭 1:开启(【1】:是,【0】:否) false integer
      integerWay 取整方式 0:向上取整 1:向下取整 2:四舍五入(【0】:向上取整,【1】:向下取整,【2】:四舍五入) false integer
      maxInventory 最大库存 false number
      minInventory 最小库存 false number
      minPackQuantity 存货最小包装 false number
      rePurchasePoint 再订货点 false number
      realCostPrice 实际成本 false number
      safetyInventory 安全库存 false number
      shelfLife 保质期,单位:天 false integer
      snType 是否开启序列号管理 CATEGORY 上级规则:分类、CURRENT 当前规则(【CATEGORY】:上级规则:分类,【CURRENT】:当前规则),可用值:CATEGORY,CURRENT false string
      useBatch 是否开启批次&计划 false integer
      useKey 是否关键(【1】:是,【0】:否) false integer
      useLockInventory 是否启用锁库 false integer
      useOverdueMessage 是否开启逾期消息提醒(【1】:是,【0】:否) false integer
      useSN 是否开启序列号管理(【1】:是,【0】:否) false integer
      useSafetyInventory 是否开启安全库存 false integer
    itemAssistUnits 辅助单位 false array ItemAssistUnitParam
      assistToBaseRatioVal 辅助-基本,辅助单位个数 false number
      baseToAssistRatioVal 基本-辅助,基本单位个数 false number
      unitCode 辅助单位 false string
    itemAttachmentAttributes 物料附件属性 false ItemAttachmentAttributes ItemAttachmentAttributes
      attachments 附件信息 false array AttachmentParam
        name false string
        size false integer
        type false string
        url false string
      blueprints 设计图 false array AttachmentParam
        name false string
        size false integer
        type false string
        url false string
      comments 备注 false string
    itemCustomizeFields 自定义字段 false object
    itemQualityInspectionAttributes 采购收货检验属性 false ItemQualityInspectionAttributes ItemQualityInspectionAttributes
      procurementInspectionScheme 检验方案 false string
      procurementInspectionStandard 检验规范 false string
      useProcurementInspection 是否启用来料检验,注意区分生产检验 false integer
    itemSpecificationConfigParams 可配置规格 false array ItemSpecificationConfigParam
      key 可配置规格 false string
      valueSet 规格值集合 false array string
      valuesFrom 规格来源(【0】:自定义,【1】:规格库) false integer
    itemSupplyChainAttributes 供应链属性 false ItemSupplyChainAttributes ItemSupplyChainAttributes
      isConfigurable 可配置(【1】:是,【0】:否) false integer
      overDeliveryRate 销售超额发货比例 false number
      overReceiveRate 超额收货比例 false number
      procurementPrice 采购价 false number
      procurementPriceType 采购单价类型(【1】:含税,【2】:不含税) false integer
      procurementTax 采购税率 false number
      salePrice 销售市场价 false number
      salePriceType 销售单价类型(【1】:含税,【2】:不含税) false integer
      saleTax 销售税率 false number
    itemUnit 多单位属性 false ItemUnit ItemUnit
      inventoryUnit 库存单位 false string
      jbkUnit 报工单位 false string
      productionUnit 生产单位 false string
      purchaseUnit 采购单位 false string
      saleUnit 销售单位 false string
    itemUnitParam 物料单位 false ItemUnitParam ItemUnitParam
      baseToInventoryQuantity 基本-库存 false number
      baseToProductionQuantity 基本-生产 false number
      baseToPurchaseQuantity 基本-采购 false number
      baseToSaleQuantity 基本-销售 false number
      baseUnitName 基本单位 false string
      inventoryToBaseQuantity 库存-基本 false number
      inventoryUnitName 库存单位 false string
      jbkToProductionQuantity 报工-生产 false number
      jbkUnitName 报工单位 false string
      productionToBaseQuantity 生产-基本呢 false number
      productionToJbkQuantity 生产-报工 false number
      productionUnitName 生产单位 false string
      purchaseToBaseQuantity 采购-基本 false number
      purchaseUnitName 采购单位 false string
      saleToBaseQuantity 销售-基本 false number
      saleUnitName 销售单位 false string
    manufactureAttributes 计划&生产属性 false ManufactureAttributes ManufactureAttributes
      batchSize 流转批量大小 false number
      dailyProduction 日产能 false number
      defectiveRate 次品率 false number
      incrementSize 增量大小 false number
      planBatchSize 计划批量大小 false number
      planStrategy 计划策略,可用值:1,2 false integer
    name 名称 true string
    status 物料状态(【DISABLED】:已禁用,【ENABLE】:已启用,【TO_BE_DISABLED】:待禁用,【TO_BE_ENABLE】:待启用),可用值:DISABLED,ENABLE,TO_BE_DISABLED,TO_BE_ENABLE false string
    type 物料类型,可用值:products,semi_products,materials true string
    unit 单位 true string
    updateItemSpecificationConfig 是否更新配置属性项,默认false false boolean

响应状态:

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

响应参数:

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

响应示例:

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

# 创建或更新

接口地址:/api/open/v2/items/createOrUpdate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "allowOutsource": 0,
    "allowProduction": 0,
    "allowPurchase": 0,
    "allowSale": 0,
    "attributes": [
      {
        "code": "",
        "key": "颜色",
        "value": "新核云蓝"
      }
    ],
    "auditStatus": "",
    "categoryCode": "",
    "code": "",
    "inventoryAttributes": {
      "abcCategory": 0,
      "cost": 0,
      "defaultWarehouseCode": "",
      "defaultWarehouseLocation": "",
      "enableInteger": 0,
      "integerWay": 0,
      "maxInventory": 0,
      "minInventory": 0,
      "minPackQuantity": 0,
      "rePurchasePoint": 0,
      "realCostPrice": 0,
      "safetyInventory": 0,
      "shelfLife": 0,
      "snType": "",
      "useBatch": 0,
      "useKey": 0,
      "useLockInventory": 0,
      "useOverdueMessage": 0,
      "useSN": 0,
      "useSafetyInventory": 0
    },
    "itemAssistUnits": [
      {
        "assistToBaseRatioVal": 0,
        "baseToAssistRatioVal": 0,
        "unitCode": ""
      }
    ],
    "itemAttachmentAttributes": {
      "attachments": [
        {
          "name": "",
          "size": 0,
          "type": "",
          "url": ""
        }
      ],
      "blueprints": [
        {
          "name": "",
          "size": 0,
          "type": "",
          "url": ""
        }
      ],
      "comments": ""
    },
    "itemCustomizeFields": {},
    "itemQualityInspectionAttributes": {
      "procurementInspectionScheme": "",
      "procurementInspectionStandard": "",
      "useProcurementInspection": 0
    },
    "itemSpecificationConfigParams": [
      {
        "key": "",
        "valueSet": [],
        "valuesFrom": 0
      }
    ],
    "itemSupplyChainAttributes": {
      "isConfigurable": 0,
      "overDeliveryRate": 0,
      "overReceiveRate": 0,
      "procurementPrice": 0,
      "procurementPriceType": 0,
      "procurementTax": 0,
      "salePrice": 0,
      "salePriceType": 0,
      "saleTax": 0
    },
    "itemUnit": {
      "inventoryUnit": "",
      "jbkUnit": "",
      "productionUnit": "",
      "purchaseUnit": "",
      "saleUnit": ""
    },
    "itemUnitParam": {
      "baseToInventoryQuantity": 0,
      "baseToProductionQuantity": 0,
      "baseToPurchaseQuantity": 0,
      "baseToSaleQuantity": 0,
      "baseUnitName": "",
      "inventoryToBaseQuantity": 0,
      "inventoryUnitName": "",
      "jbkToProductionQuantity": 0,
      "jbkUnitName": "",
      "productionToBaseQuantity": 0,
      "productionToJbkQuantity": 0,
      "productionUnitName": "",
      "purchaseToBaseQuantity": 0,
      "purchaseUnitName": "",
      "saleToBaseQuantity": 0,
      "saleUnitName": ""
    },
    "manufactureAttributes": {
      "batchSize": 0,
      "dailyProduction": 0,
      "defectiveRate": 0,
      "incrementSize": 0,
      "planBatchSize": 0,
      "planStrategy": 0
    },
    "name": "",
    "status": "",
    "type": "",
    "unit": "",
    "updateItemSpecificationConfig": true
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
saveParamRequestParameter saveParamRequestParameter body true RequestParameter«ItemSaveParam» RequestParameter«ItemSaveParam»
  body false ItemSaveParam ItemSaveParam
    allowOutsource 允许委外 false integer
    allowProduction 允许生产 false integer
    allowPurchase 允许采购 false integer
    allowSale 允许销售 false integer
    attributes 规格属性,最多 5 条 false array Spec
      code false string
      key 属性名 true string
      value 属性值 true string
    auditStatus 物料审核状态(【TO_BE_SUBMIT】:待提交,【AUDITING】:审核中,【AUDITED】:已审核),可用值:TO_BE_SUBMIT,AUDITING,AUDITED false string
    categoryCode 物料分类编码 true string
    code 物料编码 true string
    inventoryAttributes 库存属性 false InventoryAttributes InventoryAttributes
      abcCategory ABC类,可用值:0,1,2,3 false integer
      cost 参考成本 false number
      defaultWarehouseCode 默认仓库编码 false string
      defaultWarehouseLocation 默认库位编码 false string
      enableInteger 是否开启取整 0:关闭 1:开启(【1】:是,【0】:否) false integer
      integerWay 取整方式 0:向上取整 1:向下取整 2:四舍五入(【0】:向上取整,【1】:向下取整,【2】:四舍五入) false integer
      maxInventory 最大库存 false number
      minInventory 最小库存 false number
      minPackQuantity 存货最小包装 false number
      rePurchasePoint 再订货点 false number
      realCostPrice 实际成本 false number
      safetyInventory 安全库存 false number
      shelfLife 保质期,单位:天 false integer
      snType 是否开启序列号管理 CATEGORY 上级规则:分类、CURRENT 当前规则(【CATEGORY】:上级规则:分类,【CURRENT】:当前规则),可用值:CATEGORY,CURRENT false string
      useBatch 是否开启批次&计划 false integer
      useKey 是否关键(【1】:是,【0】:否) false integer
      useLockInventory 是否启用锁库 false integer
      useOverdueMessage 是否开启逾期消息提醒(【1】:是,【0】:否) false integer
      useSN 是否开启序列号管理(【1】:是,【0】:否) false integer
      useSafetyInventory 是否开启安全库存 false integer
    itemAssistUnits 辅助单位 false array ItemAssistUnitParam
      assistToBaseRatioVal 辅助-基本,辅助单位个数 false number
      baseToAssistRatioVal 基本-辅助,基本单位个数 false number
      unitCode 辅助单位 false string
    itemAttachmentAttributes 物料附件属性 false ItemAttachmentAttributes ItemAttachmentAttributes
      attachments 附件信息 false array AttachmentParam
        name false string
        size false integer
        type false string
        url false string
      blueprints 设计图 false array AttachmentParam
        name false string
        size false integer
        type false string
        url false string
      comments 备注 false string
    itemCustomizeFields 自定义字段 false object
    itemQualityInspectionAttributes 采购收货检验属性 false ItemQualityInspectionAttributes ItemQualityInspectionAttributes
      procurementInspectionScheme 检验方案 false string
      procurementInspectionStandard 检验规范 false string
      useProcurementInspection 是否启用来料检验,注意区分生产检验 false integer
    itemSpecificationConfigParams 可配置规格 false array ItemSpecificationConfigParam
      key 可配置规格 false string
      valueSet 规格值集合 false array string
      valuesFrom 规格来源(【0】:自定义,【1】:规格库) false integer
    itemSupplyChainAttributes 供应链属性 false ItemSupplyChainAttributes ItemSupplyChainAttributes
      isConfigurable 可配置(【1】:是,【0】:否) false integer
      overDeliveryRate 销售超额发货比例 false number
      overReceiveRate 超额收货比例 false number
      procurementPrice 采购价 false number
      procurementPriceType 采购单价类型(【1】:含税,【2】:不含税) false integer
      procurementTax 采购税率 false number
      salePrice 销售市场价 false number
      salePriceType 销售单价类型(【1】:含税,【2】:不含税) false integer
      saleTax 销售税率 false number
    itemUnit 多单位属性 false ItemUnit ItemUnit
      inventoryUnit 库存单位 false string
      jbkUnit 报工单位 false string
      productionUnit 生产单位 false string
      purchaseUnit 采购单位 false string
      saleUnit 销售单位 false string
    itemUnitParam 物料单位 false ItemUnitParam ItemUnitParam
      baseToInventoryQuantity 基本-库存 false number
      baseToProductionQuantity 基本-生产 false number
      baseToPurchaseQuantity 基本-采购 false number
      baseToSaleQuantity 基本-销售 false number
      baseUnitName 基本单位 false string
      inventoryToBaseQuantity 库存-基本 false number
      inventoryUnitName 库存单位 false string
      jbkToProductionQuantity 报工-生产 false number
      jbkUnitName 报工单位 false string
      productionToBaseQuantity 生产-基本呢 false number
      productionToJbkQuantity 生产-报工 false number
      productionUnitName 生产单位 false string
      purchaseToBaseQuantity 采购-基本 false number
      purchaseUnitName 采购单位 false string
      saleToBaseQuantity 销售-基本 false number
      saleUnitName 销售单位 false string
    manufactureAttributes 计划&生产属性 false ManufactureAttributes ManufactureAttributes
      batchSize 流转批量大小 false number
      dailyProduction 日产能 false number
      defectiveRate 次品率 false number
      incrementSize 增量大小 false number
      planBatchSize 计划批量大小 false number
      planStrategy 计划策略,可用值:1,2 false integer
    name 名称 true string
    status 物料状态(【DISABLED】:已禁用,【ENABLE】:已启用,【TO_BE_DISABLED】:待禁用,【TO_BE_ENABLE】:待启用),可用值:DISABLED,ENABLE,TO_BE_DISABLED,TO_BE_ENABLE false string
    type 物料类型,可用值:products,semi_products,materials true string
    unit 单位 true string
    updateItemSpecificationConfig 是否更新配置属性项,默认false false boolean

响应状态:

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

响应参数:

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

响应示例:

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

# 删除物料

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

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
requestParameter requestParameter body true RequestParameter«string» RequestParameter«string»
  body 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": ""
}

# 禁用物料

接口地址:/api/open/v2/items/prohibit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
requestParameter requestParameter body true RequestParameter«string» RequestParameter«string»
  body 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": ""
}

# 查询物料列表

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

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {}
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
queryParamRequestParameter queryParamRequestParameter body true RequestParameter«ItemQueryParam» RequestParameter«ItemQueryParam»
  body false ItemQueryParam ItemQueryParam

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data ListPagingResponseData«ItemDTO» ListPagingResponseData«ItemDTO»
  length integer(int32)
  list array ItemDTO
  recordsTotal integer(int32)
  start integer(int32)
message string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [
			{}
		],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

# 查询物料列表(精简物料格式)

接口地址:/api/open/v2/items/simple/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {}
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
parameter parameter body true RequestParameter«ItemQueryParam» RequestParameter«ItemQueryParam»
  body false ItemQueryParam ItemQueryParam

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data ListPagingResponseData«ItemSimpleDTO» ListPagingResponseData«ItemSimpleDTO»
  length integer(int32)
  list array ItemSimpleDTO
    allowProduction 允许生产 integer
    allowPurchase 允许采购 integer
    allowSale 允许销售 integer
    auditStatus 物料审核状态(【TO_BE_SUBMIT】:待提交,【AUDITING】:审核中,【AUDITED】:已审核),可用值:TO_BE_SUBMIT,AUDITING,AUDITED string
    category 物料分类 ItemCategoryDTO ItemCategoryDTO
      code 编码 string
      inventoryCycle 库存周转期限,单位:天 integer
      name 名称 string
      parentCode 父级分类编码,如无则为空 string
      parentName 父级分类名称,如无则为空 string
    code 编码 string
    name 名称 string
    status 物料状态(【DISABLED】:已禁用,【ENABLE】:已启用,【TO_BE_DISABLED】:待禁用,【TO_BE_ENABLE】:待启用),可用值:DISABLED,ENABLE,TO_BE_DISABLED,TO_BE_ENABLE string
    type 物料类型,可用值:products,semi_products,materials string
    unit 单位 string
  recordsTotal integer(int32)
  start integer(int32)
message string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [
			{
				"allowProduction": 0,
				"allowPurchase": 0,
				"allowSale": 0,
				"auditStatus": "",
				"category": {
					"code": "IRON_001",
					"inventoryCycle": 90,
					"name": "五金件",
					"parentCode": "Mat_101",
					"parentName": "成品"
				},
				"code": "",
				"name": "",
				"status": "",
				"type": "",
				"unit": ""
			}
		],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

# 修改物料详情

接口地址:/api/open/v2/items/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "allowOutsource": 0,
    "allowProduction": 0,
    "allowPurchase": 0,
    "allowSale": 0,
    "attributes": [
      {
        "code": "",
        "key": "颜色",
        "value": "新核云蓝"
      }
    ],
    "auditStatus": "",
    "categoryCode": "",
    "code": "",
    "inventoryAttributes": {
      "abcCategory": 0,
      "cost": 0,
      "defaultWarehouseCode": "",
      "defaultWarehouseLocation": "",
      "enableInteger": 0,
      "integerWay": 0,
      "maxInventory": 0,
      "minInventory": 0,
      "minPackQuantity": 0,
      "rePurchasePoint": 0,
      "realCostPrice": 0,
      "safetyInventory": 0,
      "shelfLife": 0,
      "snType": "",
      "useBatch": 0,
      "useKey": 0,
      "useLockInventory": 0,
      "useOverdueMessage": 0,
      "useSN": 0,
      "useSafetyInventory": 0
    },
    "itemAssistUnits": [
      {
        "assistToBaseRatioVal": 0,
        "baseToAssistRatioVal": 0,
        "unitCode": ""
      }
    ],
    "itemAttachmentAttributes": {
      "attachments": [
        {
          "name": "",
          "size": 0,
          "type": "",
          "url": ""
        }
      ],
      "blueprints": [
        {
          "name": "",
          "size": 0,
          "type": "",
          "url": ""
        }
      ],
      "comments": ""
    },
    "itemCustomizeFields": {},
    "itemQualityInspectionAttributes": {
      "procurementInspectionScheme": "",
      "procurementInspectionStandard": "",
      "useProcurementInspection": 0
    },
    "itemSpecificationConfigParams": [
      {
        "key": "",
        "valueSet": [],
        "valuesFrom": 0
      }
    ],
    "itemSupplyChainAttributes": {
      "isConfigurable": 0,
      "overDeliveryRate": 0,
      "overReceiveRate": 0,
      "procurementPrice": 0,
      "procurementPriceType": 0,
      "procurementTax": 0,
      "salePrice": 0,
      "salePriceType": 0,
      "saleTax": 0
    },
    "itemUnit": {
      "inventoryUnit": "",
      "jbkUnit": "",
      "productionUnit": "",
      "purchaseUnit": "",
      "saleUnit": ""
    },
    "itemUnitParam": {
      "baseToInventoryQuantity": 0,
      "baseToProductionQuantity": 0,
      "baseToPurchaseQuantity": 0,
      "baseToSaleQuantity": 0,
      "baseUnitName": "",
      "inventoryToBaseQuantity": 0,
      "inventoryUnitName": "",
      "jbkToProductionQuantity": 0,
      "jbkUnitName": "",
      "productionToBaseQuantity": 0,
      "productionToJbkQuantity": 0,
      "productionUnitName": "",
      "purchaseToBaseQuantity": 0,
      "purchaseUnitName": "",
      "saleToBaseQuantity": 0,
      "saleUnitName": ""
    },
    "manufactureAttributes": {
      "batchSize": 0,
      "dailyProduction": 0,
      "defectiveRate": 0,
      "incrementSize": 0,
      "planBatchSize": 0,
      "planStrategy": 0
    },
    "name": "",
    "status": "",
    "type": "",
    "unit": "",
    "updateItemSpecificationConfig": true
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
itemSaveParamRequestParameter itemSaveParamRequestParameter body true RequestParameter«ItemSaveParam» RequestParameter«ItemSaveParam»
  body false ItemSaveParam ItemSaveParam
    allowOutsource 允许委外 false integer
    allowProduction 允许生产 false integer
    allowPurchase 允许采购 false integer
    allowSale 允许销售 false integer
    attributes 规格属性,最多 5 条 false array Spec
      code false string
      key 属性名 true string
      value 属性值 true string
    auditStatus 物料审核状态(【TO_BE_SUBMIT】:待提交,【AUDITING】:审核中,【AUDITED】:已审核),可用值:TO_BE_SUBMIT,AUDITING,AUDITED false string
    categoryCode 物料分类编码 true string
    code 物料编码 true string
    inventoryAttributes 库存属性 false InventoryAttributes InventoryAttributes
      abcCategory ABC类,可用值:0,1,2,3 false integer
      cost 参考成本 false number
      defaultWarehouseCode 默认仓库编码 false string
      defaultWarehouseLocation 默认库位编码 false string
      enableInteger 是否开启取整 0:关闭 1:开启(【1】:是,【0】:否) false integer
      integerWay 取整方式 0:向上取整 1:向下取整 2:四舍五入(【0】:向上取整,【1】:向下取整,【2】:四舍五入) false integer
      maxInventory 最大库存 false number
      minInventory 最小库存 false number
      minPackQuantity 存货最小包装 false number
      rePurchasePoint 再订货点 false number
      realCostPrice 实际成本 false number
      safetyInventory 安全库存 false number
      shelfLife 保质期,单位:天 false integer
      snType 是否开启序列号管理 CATEGORY 上级规则:分类、CURRENT 当前规则(【CATEGORY】:上级规则:分类,【CURRENT】:当前规则),可用值:CATEGORY,CURRENT false string
      useBatch 是否开启批次&计划 false integer
      useKey 是否关键(【1】:是,【0】:否) false integer
      useLockInventory 是否启用锁库 false integer
      useOverdueMessage 是否开启逾期消息提醒(【1】:是,【0】:否) false integer
      useSN 是否开启序列号管理(【1】:是,【0】:否) false integer
      useSafetyInventory 是否开启安全库存 false integer
    itemAssistUnits 辅助单位 false array ItemAssistUnitParam
      assistToBaseRatioVal 辅助-基本,辅助单位个数 false number
      baseToAssistRatioVal 基本-辅助,基本单位个数 false number
      unitCode 辅助单位 false string
    itemAttachmentAttributes 物料附件属性 false ItemAttachmentAttributes ItemAttachmentAttributes
      attachments 附件信息 false array AttachmentParam
        name false string
        size false integer
        type false string
        url false string
      blueprints 设计图 false array AttachmentParam
        name false string
        size false integer
        type false string
        url false string
      comments 备注 false string
    itemCustomizeFields 自定义字段 false object
    itemQualityInspectionAttributes 采购收货检验属性 false ItemQualityInspectionAttributes ItemQualityInspectionAttributes
      procurementInspectionScheme 检验方案 false string
      procurementInspectionStandard 检验规范 false string
      useProcurementInspection 是否启用来料检验,注意区分生产检验 false integer
    itemSpecificationConfigParams 可配置规格 false array ItemSpecificationConfigParam
      key 可配置规格 false string
      valueSet 规格值集合 false array string
      valuesFrom 规格来源(【0】:自定义,【1】:规格库) false integer
    itemSupplyChainAttributes 供应链属性 false ItemSupplyChainAttributes ItemSupplyChainAttributes
      isConfigurable 可配置(【1】:是,【0】:否) false integer
      overDeliveryRate 销售超额发货比例 false number
      overReceiveRate 超额收货比例 false number
      procurementPrice 采购价 false number
      procurementPriceType 采购单价类型(【1】:含税,【2】:不含税) false integer
      procurementTax 采购税率 false number
      salePrice 销售市场价 false number
      salePriceType 销售单价类型(【1】:含税,【2】:不含税) false integer
      saleTax 销售税率 false number
    itemUnit 多单位属性 false ItemUnit ItemUnit
      inventoryUnit 库存单位 false string
      jbkUnit 报工单位 false string
      productionUnit 生产单位 false string
      purchaseUnit 采购单位 false string
      saleUnit 销售单位 false string
    itemUnitParam 物料单位 false ItemUnitParam ItemUnitParam
      baseToInventoryQuantity 基本-库存 false number
      baseToProductionQuantity 基本-生产 false number
      baseToPurchaseQuantity 基本-采购 false number
      baseToSaleQuantity 基本-销售 false number
      baseUnitName 基本单位 false string
      inventoryToBaseQuantity 库存-基本 false number
      inventoryUnitName 库存单位 false string
      jbkToProductionQuantity 报工-生产 false number
      jbkUnitName 报工单位 false string
      productionToBaseQuantity 生产-基本呢 false number
      productionToJbkQuantity 生产-报工 false number
      productionUnitName 生产单位 false string
      purchaseToBaseQuantity 采购-基本 false number
      purchaseUnitName 采购单位 false string
      saleToBaseQuantity 销售-基本 false number
      saleUnitName 销售单位 false string
    manufactureAttributes 计划&生产属性 false ManufactureAttributes ManufactureAttributes
      batchSize 流转批量大小 false number
      dailyProduction 日产能 false number
      defectiveRate 次品率 false number
      incrementSize 增量大小 false number
      planBatchSize 计划批量大小 false number
      planStrategy 计划策略,可用值:1,2 false integer
    name 名称 true string
    status 物料状态(【DISABLED】:已禁用,【ENABLE】:已启用,【TO_BE_DISABLED】:待禁用,【TO_BE_ENABLE】:待启用),可用值:DISABLED,ENABLE,TO_BE_DISABLED,TO_BE_ENABLE false string
    type 物料类型,可用值:products,semi_products,materials true string
    unit 单位 true string
    updateItemSpecificationConfig 是否更新配置属性项,默认false false boolean

响应状态:

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

响应参数:

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

响应示例:

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

# 物料-单位API

# 创建物料单位

接口地址:/api/open/v2/item/units/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "isMaterialDefaultUnit": 0,
    "isProductDefaultUnit": 0,
    "isSemiProductDefaultUnit": 0,
    "name": ""
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
itemUnitSaveParamRequestParameter itemUnitSaveParamRequestParameter body true RequestParameter«ItemUnitSaveParam» RequestParameter«ItemUnitSaveParam»
  body false ItemUnitSaveParam ItemUnitSaveParam
    isMaterialDefaultUnit 原料默认单位,可用值:0,1 false integer
    isProductDefaultUnit 产品默认单位,可用值:0,1 false integer
    isSemiProductDefaultUnit 半成品默认单位,可用值:0,1 false integer
    name 名称 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": ""
}

# 创建或修改物料单位详情

接口地址:/api/open/v2/item/units/createOrUpdate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "isMaterialDefaultUnit": 0,
    "isProductDefaultUnit": 0,
    "isSemiProductDefaultUnit": 0,
    "name": "",
    "newName": ""
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
itemUnitSaveParamRequestParameter itemUnitSaveParamRequestParameter body true RequestParameter«ItemUnitUpdateParam» RequestParameter«ItemUnitUpdateParam»
  body false ItemUnitUpdateParam ItemUnitUpdateParam
    isMaterialDefaultUnit 原料默认单位,可用值:0,1 false integer
    isProductDefaultUnit 产品默认单位,可用值:0,1 false integer
    isSemiProductDefaultUnit 半成品默认单位,可用值:0,1 false integer
    name 旧名称 false string
    newName 新的名称 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": ""
}

# 删除物料单位

接口地址:/api/open/v2/item/units/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
code code body true RequestParameter«string» RequestParameter«string»
  body 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": ""
}

# 查询物料单位列表

接口地址:/api/open/v2/item/units/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "isMaterialDefaultUnit": 0,
    "isProductDefaultUnit": 0,
    "isSemiProductDefaultUnit": 0,
    "name": "",
    "nameLike": "",
    "names": [],
    "pagingParam": {
      "length": 0,
      "start": 0
    }
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
queryParamRequestParameter queryParamRequestParameter body true RequestParameter«ItemUnitQueryParam» RequestParameter«ItemUnitQueryParam»
  body false ItemUnitQueryParam ItemUnitQueryParam
    isMaterialDefaultUnit 检索原料默认单位 false integer
    isProductDefaultUnit 检索产品默认单位 false integer
    isSemiProductDefaultUnit 检索半成品默认单位 false integer
    name 名称完全匹配 false string
    nameLike 名称模糊匹配 false string
    names 名称列表完全匹配 false array string
    pagingParam false PagingParam PagingParam
      length false integer
      start false integer

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data ListPagingResponseData«ItemUnitDTO» ListPagingResponseData«ItemUnitDTO»
  length integer(int32)
  list array ItemUnitDTO
    isMaterialDefaultUnit 原料默认单位 integer
    isProductDefaultUnit 产品默认单位 integer
    isSemiProductDefaultUnit 半成品默认单位 integer
    name 名称 string
  recordsTotal integer(int32)
  start integer(int32)
message string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [
			{
				"isMaterialDefaultUnit": 1,
				"isProductDefaultUnit": 0,
				"isSemiProductDefaultUnit": 0,
				"name": "PCS"
			}
		],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

# 修改物料单位详情

接口地址:/api/open/v2/item/units/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "isMaterialDefaultUnit": 0,
    "isProductDefaultUnit": 0,
    "isSemiProductDefaultUnit": 0,
    "name": "",
    "newName": ""
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
itemUnitSaveParamRequestParameter itemUnitSaveParamRequestParameter body true RequestParameter«ItemUnitUpdateParam» RequestParameter«ItemUnitUpdateParam»
  body false ItemUnitUpdateParam ItemUnitUpdateParam
    isMaterialDefaultUnit 原料默认单位,可用值:0,1 false integer
    isProductDefaultUnit 产品默认单位,可用值:0,1 false integer
    isSemiProductDefaultUnit 半成品默认单位,可用值:0,1 false integer
    name 旧名称 false string
    newName 新的名称 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": ""
}

# 物料规格库 API

# 创建或更新

接口地址:/api/open/v2/item/specification/createOrUpdate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "specificationName": "",
    "specificationValues": [
      {
        "code": "",
        "seq": 0,
        "value": ""
      }
    ]
  }
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
saveParamRequestParameter saveParamRequestParameter body true RequestParameter«ItemSpecificationSaveParam» RequestParameter«ItemSpecificationSaveParam»
  body false ItemSpecificationSaveParam ItemSpecificationSaveParam
    specificationName 规格名称 false string
    specificationValues 规格值列表 false array ItemSpecificationValueSaveParam
      code 规格值编码 false string
      seq 规格值序号 false integer
      value 规格值 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": ""
}