infilake-bidding 开放API接口文档
Profile API (/open/v1/profile)
GET /open/v1/profile - 获取Profile
请求头
| 参数名 |
类型 |
必填 |
描述 |
| X-Access-Key |
String |
必填 |
访问密钥 |
响应对象:ProfileDTO
| 字段名 |
类型 |
描述 |
| organization |
Organization |
组织信息 |
| purchaser |
Purchaser |
采购商信息 |
响应对象内部结构:
Organization 对象结构:
| 字段名 |
类型 |
描述 |
| id |
Integer |
组织ID |
| name |
String |
组织名称 |
| description |
String |
组织描述 |
| createdBy |
Integer |
创建者ID |
| createdName |
String |
创建者名称 |
| createdAt |
Date |
创建时间 |
| updatedAt |
Date |
更新时间 |
| isDeleted |
Integer |
是否删除 |
| deletedAt |
Date |
删除时间 |
| type |
String |
组织类型 |
| principalId |
Integer |
负责人ID |
| principal |
User |
负责人信息 |
| companyName |
String |
公司名称 |
Purchaser 对象结构:
| 字段名 |
类型 |
描述 |
| id |
Long |
采购商ID |
| name |
String |
采购商名称 |
| contactPerson |
String |
联系人姓名 |
| contactPhone |
String |
联系电话 |
| email |
String |
邮箱地址 |
| address |
String |
地址 |
| creditRating |
Byte |
信用等级 |
| isActive |
String |
是否激活 |
| createdAt |
Date |
创建时间 |
| certificationDate |
Date |
认证日期 |
| bankAccount |
String |
银行账户 |
| companyNo |
String |
公司编号 |
| ownerId |
Integer |
所有者ID |
订单API (/open/v1/order)
GET /open/v1/order/page - 订单信息分页查询
请求参数
| 参数名 |
类型 |
必填 |
描述 |
| pageNo |
long |
可选 |
页码,默认值:1 |
| pageSize |
long |
可选 |
每页数量,默认值:10 |
| status |
String |
可选 |
订单状态:'approved' 采购方确认, 'wait' 等待采购方确认, 'cancel' 采购方取消, 'supplier_cancel' 供应商取消, 'supplier_apply_cancel' 供应商申请取消 |
| acceptanceStatus |
String |
可选 |
验收状态:'full_accepted' 验收通过, 'not_accepted' 未验收, 'partial_accepted' 部分验收通过 |
| issueStatus |
String |
可选 |
结算状态:'unissued' 未结算, 'issued' 已结算, 'issuing' 结算中 |
| start |
Date |
可选 |
开始时间,格式:yyyy-MM-dd |
| end |
Date |
可选 |
结束时间,格式:yyyy-MM-dd |
响应对象:OrderInfo
| 字段名 |
类型 |
描述 |
| id |
Integer |
订单ID |
| supplierId |
Integer |
供应商ID |
| orderNo |
String |
订单编号 |
| applicantName |
String |
申请人姓名 |
| applicationId |
Integer |
申请单ID |
| amount |
BigDecimal |
订单金额 |
| payType |
String |
支付类型 |
| createdAt |
Date |
创建时间 |
| comment |
String |
备注 |
| status |
String |
订单状态:'approved' 通过,'wait' 待确定 ,'cancel' 订单取消 |
| approverId |
Integer |
审批人ID |
| approveDate |
Date |
审批日期 |
| payStatus |
String |
付款状态:'unpaid' 未支付,'paid' 已支付 |
| payUserId |
Integer |
付款用户ID |
| payDate |
Date |
付款日期 |
| issueStatus |
String |
发货状态:'unissue' 未发货,'issue' 已发货 |
| issueUserId |
Integer |
发货用户ID |
| issueDate |
Date |
发货日期 |
| expressCost |
BigDecimal |
快递费用 |
| discount |
BigDecimal |
折扣金额 |
| recipientId |
Integer |
收件人ID |
| orderOrganizationId |
Integer |
订单组织ID |
| teamId |
Integer |
团队ID |
| supplier |
SupplierVO |
供应商信息 |
| purchaser |
Purchaser |
采购商信息 |
| recipient |
RecipientInfo |
收件人信息 |
| isDeleted |
Integer |
是否删除 |
| deleteUserId |
Integer |
删除用户ID |
| deleteDate |
Date |
删除日期 |
| expectedDate |
Date |
期望交付日期 |
| acceptanceDate |
Date |
验收日期 |
| acceptanceStatus |
String |
验收状态:'full_accepted' 全部验收通过,'not_accepted' 未验收,'partial_accepted' 部分验收通过 |
| acceptor |
List<User> |
验收人列表 |
| invoiceStatus |
String |
发票状态 |
| invoiceUserId |
Integer |
发票处理用户ID |
| invoiceDate |
Date |
发票日期 |
| allowAccept |
Boolean |
允许验收 |
| purchaserId |
Integer |
采购商ID |
| cancelReason |
String |
取消原因 |
| billStatus |
String |
账单状态 |
| fulfillmentStatus |
String |
履约状态 |
| returnAmount |
BigDecimal |
退货金额 |
GET /open/v1/order/detail/{orderNo} - 订单详情
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| orderNo |
String |
必填 |
订单编号 |
响应对象:OrderInfoVO(继承自OrderInfo)
| 字段名 |
类型 |
描述 |
| orderFulfillments |
List<OrderFulfillment> |
订单履约列表 |
| [继承自OrderInfo的字段] |
见上表 |
继承自OrderInfo的所有字段 |
GET /open/v1/order/clientApplicationNo/{client_application_no} - 根据客户端申请单号查询订单
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| client_application_no |
String |
必填 |
客户端申请单号 |
响应对象:List<OrderInfoDetailClient>
| 字段名 |
类型 |
描述 |
| id |
Integer |
订单ID |
| supplierId |
Integer |
供应商ID |
| orderNo |
String |
订单号 |
| applicantName |
String |
申请人名称 |
| applicationId |
Integer |
申请单ID |
| amount |
BigDecimal |
订单金额 |
| payType |
String |
支付方式 |
| createdAt |
Date |
创建时间(格式:yyyy-MM-dd HH:mm:ss) |
| comment |
String |
备注 |
| status |
String |
订单状态(approved-通过, wait-待确定, cancel-订单取消) |
| approverId |
Integer |
审批人ID |
| approveDate |
Date |
审批日期(格式:yyyy-MM-dd HH:mm:ss) |
| payStatus |
String |
付款状态(unpaid-未支付, paid-已支付) |
| payUserId |
Integer |
付款用户ID |
| payDate |
Date |
付款日期(格式:yyyy-MM-dd HH:mm:ss) |
| issueStatus |
String |
发票状态(unissue-未发货, issue-已发货) |
| issueUserId |
Integer |
发货用户ID |
| issueDate |
Date |
发货日期(格式:yyyy-MM-dd HH:mm:ss) |
| expressCost |
BigDecimal |
快递费用 |
| discount |
BigDecimal |
折扣 |
| recipientId |
Integer |
收货人ID |
| orderOrganizationId |
Integer |
订单组织ID |
| teamId |
Integer |
团队ID |
| supplier |
SupplierVO |
供应商信息 |
| purchaser |
Purchaser |
采购方信息 |
| recipient |
RecipientInfo |
收货人信息 |
| isDeleted |
Integer |
是否删除 |
| deleteUserId |
Integer |
删除用户ID |
| deleteDate |
Date |
删除日期(格式:yyyy-MM-dd HH:mm:ss) |
| expectedDate |
Date |
预期日期(格式:yyyy-MM-dd HH:mm:ss) |
| acceptanceDate |
Date |
验收日期(格式:yyyy-MM-dd HH:mm:ss) |
| acceptanceStatus |
String |
验收状态(full_accepted-全部验收通过, not_accepted-未验收, partial_accepted-部分验收通过) |
| acceptor |
List<User> |
验收人列表 |
| invoiceStatus |
String |
发票状态 |
| invoiceUserId |
Integer |
开票用户ID |
| invoiceDate |
Date |
开票日期(格式:yyyy-MM-dd HH:mm:ss) |
| allowAccept |
Boolean |
是否允许验收 |
| purchaserId |
Integer |
采购方ID |
| cancelReason |
String |
取消原因 |
| billStatus |
String |
账单状态 |
| fulfillmentStatus |
String |
履约状态 |
| returnAmount |
BigDecimal |
退货金额 |
| corOrderItem |
List<OrderItem> |
关联的订单项列表 |
OrderItem 对象结构:
| 字段名 |
类型 |
描述 |
| id |
Integer |
订单项ID |
| orderId |
Integer |
订单ID |
| productName |
String |
商品名称 |
| categoryName |
String |
类别名称 |
| categoryId |
Integer |
类别ID |
| productNum |
BigDecimal |
商品数量 |
| unfulfillProductNum |
BigDecimal |
未履约商品数量 |
| productPrice |
BigDecimal |
商品单价 |
| productUnit |
String |
商品单位 |
| brand |
String |
品牌 |
| productCode |
String |
商品编码 |
| productSpec |
String |
商品规格 |
| productDesc |
String |
商品描述 |
| preItemId |
Integer |
预购项ID |
| inquiryItemId |
Integer |
询价项ID |
| orderNo |
String |
订单编号 |
| returnNumber |
BigDecimal |
退货数量 |
GET /open/v1/order/fulfilment/{fulfilmentNo} - 订单履约详情
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| fulfilmentNo |
String |
必填 |
订单履约编号 |
响应对象:OrderFulfillmentVO(继承自OrderFulfillment)
| 字段名 |
类型 |
描述 |
| fulfillmentItems |
List<OrderFulfillmentItem> |
履约项列表 |
| [继承自OrderFulfillment的字段] |
见下表 |
继承自OrderFulfillment的所有字段 |
OrderFulfillment 对象结构:
| 字段名 |
类型 |
描述 |
| id |
Integer |
履约ID |
| orderNo |
String |
订单编号 |
| orderId |
Integer |
订单ID |
| fulfillmentNo |
String |
履约单号 |
| deliverType |
String |
发货类型 |
| deliverDate |
Date |
发货日期 |
| deliverUserId |
Integer |
发货用户ID |
| deliverUserName |
String |
发货用户名 |
| deliverStatus |
String |
发货状态 |
| acceptanceDate |
Date |
验收日期 |
| acceptorId |
Integer |
验收人ID |
| acceptor |
User |
验收人信息 |
| amount |
BigDecimal |
金额 |
| typeNum |
Integer |
类型数量 |
| comment |
String |
备注 |
| createdAt |
Date |
创建时间 |
| updatedAt |
Date |
更新时间 |
| organizationId |
Integer |
组织ID |
| supplierId |
Integer |
供应商ID |
| supplierName |
String |
供应商名称 |
| reminder |
Boolean |
提醒标识 |
| allowAccept |
Boolean |
允许验收 |
GET /open/v1/order/fulfilment/clientApplicationNo/{client_application_no} - 根据客户端申请单号查询订单履约单
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| client_application_no |
String |
必填 |
客户端申请单号 |
响应对象:List<OrderFulfillmentDetailClient>
| 字段名 |
类型 |
描述 |
| id |
Integer |
履约单ID |
| orderNo |
String |
订单号 |
| orderId |
Integer |
订单ID |
| fulfillmentNo |
String |
履约单号 |
| deliverType |
Integer |
发货类型 |
| deliverDate |
Date |
发货日期 |
| deliverUserId |
Integer |
发货人ID |
| deliverUserName |
String |
发货人姓名 |
| deliverStatus |
Integer |
发货状态 |
| acceptanceDate |
Date |
验收日期 |
| acceptorId |
Integer |
验收人ID |
| acceptor |
String |
验收人 |
| amount |
BigDecimal |
金额 |
| typeNum |
Integer |
类型数量 |
| comment |
String |
备注 |
| createdAt |
Date |
创建时间 |
| updatedAt |
Date |
更新时间 |
| organizationId |
Integer |
组织ID |
| supplierId |
Integer |
供应商ID |
| supplierName |
String |
供应商名称 |
| reminder |
Integer |
提醒 |
| allowAccept |
Integer |
允许验收 |
| corFulfillmentItem |
List<OrderFulfillmentItem> |
关联的履约单项列表 |
OrderFulfillmentItem 对象结构
| 字段名 |
类型 |
描述 |
| id |
Integer |
履约单项ID |
| fulfillmentNo |
String |
履约单号 |
| orderItemId |
Integer |
订单项ID |
| categoryName |
String |
类别名称 |
| categoryId |
Integer |
类别ID |
| productNum |
BigDecimal |
商品数量 |
| productName |
String |
商品名称 |
| productPrice |
BigDecimal |
商品单价 |
| productUnit |
String |
商品单位 |
| productDesc |
String |
商品描述 |
| preItemId |
Integer |
预购项ID |
| inquiryItemId |
Integer |
询价项ID |
| productCode |
String |
商品编码 |
| productSpec |
String |
商品规格 |
| brand |
String |
品牌 |
| createdAt |
Date |
创建时间(格式:yyyy-MM-dd HH:mm:ss) |
| updatedAt |
Date |
更新时间(格式:yyyy-MM-dd HH:mm:ss) |
| returnNum |
BigDecimal |
退货数量 |
GET /open/v1/order/express/fulfillment/{fulfilmentNo} - 订单履约物流信息
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| fulfilmentNo |
String |
必填 |
订单履约编号 |
响应对象:OrderExpress
| 字段名 |
类型 |
描述 |
| id |
Integer |
物流ID |
| expressCompany |
String |
快递公司 |
| expressCode |
String |
快递代码 |
| expressNo |
String |
快递单号 |
| orderId |
Integer |
订单ID |
| expressInfo |
String |
快递信息 |
| courierName |
String |
快递员姓名 |
| phone |
String |
联系电话 |
| fulfillmentId |
Integer |
履约ID |
| returnId |
Integer |
退货ID |
| expressUpdatedAt |
Date |
快递更新时间 |
POST /open/v1/order/purchaser/in/{fulfilmentNo} - 新增收货入库
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| fulfilmentNo |
String |
必填 |
订单履约编号 |
表单参数
| 参数名 |
类型 |
必填 |
描述 |
| accompanyPics |
MultipartFile[] |
必填 |
平台送货单图片文件数组 |
| extraPics |
MultipartFile[] |
必填 |
供应商送货单图片文件数组 |
| productPics |
MultipartFile[] |
必填 |
货物图片文件数组 |
响应字段
| 字段名 |
类型 |
描述 |
| Boolean |
Boolean |
操作结果,true表示成功,false表示失败 |
GET /open/v1/order/item_return/page - 按条件分页查询退货详情
请求参数
| 参数名 |
类型 |
必填 |
描述 |
| pageNo |
long |
可选 |
页码,默认值:1 |
| pageSize |
long |
可选 |
每页数量,默认值:10 |
| status |
String |
可选 |
退货状态:PENDING_APPROVAL 待审核, PENDING_SHIPMENT 待退货, PENDING_RECEIPT 待收货, REJECTED 驳回, CANCELLED 放弃退货, CLOSED 完成退货 |
| search |
String |
可选 |
模糊查询参数 |
| start |
Date |
可选 |
开始时间,格式:yyyy-MM-dd |
| end |
Date |
可选 |
结束时间,格式:yyyy-MM-dd |
响应对象:OrderReturnItem
| 字段名 |
类型 |
描述 |
| id |
Integer |
退货项ID |
| returnNo |
String |
退货编号 |
| fulfillmentItemId |
Integer |
履约项ID |
| orderItemId |
Integer |
订单项ID |
| returnNum |
BigDecimal |
退货数量 |
| returnReason |
String |
退货原因 |
| returnUserId |
Integer |
退货用户ID |
| returnUsername |
String |
退货用户名 |
| returnPics |
List<String> |
退货图片列表 |
| returnPicsTmp |
List<String> |
退货图片临时链接列表 |
| createdAt |
Date |
创建时间 |
| updatedAt |
Date |
更新时间 |
| status |
String |
状态 |
| comment |
String |
备注 |
| organizationId |
Integer |
组织ID |
| supplierId |
Integer |
供应商ID |
| fulfillmentNo |
String |
履约单号 |
| productCode |
String |
商品编码 |
| productName |
String |
商品名称 |
| productSpec |
String |
商品规格 |
| productDesc |
String |
商品描述 |
| productUnit |
String |
商品单位 |
| productPrice |
BigDecimal |
商品单价 |
| productNum |
BigDecimal |
商品数量 |
| orderNo |
String |
订单编号 |
| preItemId |
Integer |
预购项ID |
GET /open/v1/order/item_return/{returnNo} - 退货详情
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| returnNo |
String |
必填 |
退货编号 |
响应对象:OrderReturnItem
| 字段名 |
类型 |
描述 |
| id |
Integer |
退货项ID |
| returnNo |
String |
退货编号 |
| fulfillmentItemId |
Integer |
履约项ID |
| orderItemId |
Integer |
订单项ID |
| returnNum |
BigDecimal |
退货数量 |
| returnReason |
String |
退货原因 |
| returnUserId |
Integer |
退货用户ID |
| returnUsername |
String |
退货用户名 |
| returnPics |
List<String> |
退货图片列表 |
| returnPicsTmp |
List<String> |
退货图片临时链接列表 |
| createdAt |
Date |
创建时间 |
| updatedAt |
Date |
更新时间 |
| status |
String |
状态 |
| comment |
String |
备注 |
| organizationId |
Integer |
组织ID |
| supplierId |
Integer |
供应商ID |
| fulfillmentNo |
String |
履约单号 |
| productCode |
String |
商品编码 |
| productName |
String |
商品名称 |
| productSpec |
String |
商品规格 |
| productDesc |
String |
商品描述 |
| productUnit |
String |
商品单位 |
| productPrice |
BigDecimal |
商品单价 |
| productNum |
BigDecimal |
商品数量 |
| orderNo |
String |
订单编号 |
| preItemId |
Integer |
预购项ID |
采购商品类别API (/open/v1/purchaser/category)
GET /open/v1/purchaser/category/page - 按条件分页查询商品分类
请求参数
| 参数名 |
类型 |
必填 |
描述 |
| page |
long |
可选 |
页码,默认值:1 |
| size |
long |
可选 |
每页数量,默认值:10 |
| query |
String |
可选 |
模糊查询参数,用于按类别名称、类别编码或描述进行模糊查询 |
响应对象:Page<Categories>
| 字段名 |
类型 |
描述 |
| id |
Long |
类别ID |
| categoryName |
String |
类别名称 |
| categoryCode |
String |
类别编码 |
| parentId |
Long |
父级类别ID |
| organizationId |
Integer |
组织ID |
| sort |
Integer |
排序 |
| description |
String |
描述 |
| isActive |
Boolean |
是否激活 |
POST /open/v1/purchaser/category - 新增物料类别
请求体:CategoryDTO
| 字段名 |
类型 |
必填 |
描述 |
| categoryName |
String |
必填 |
类别名称 |
| categoryCode |
String |
必填 |
类别编码 |
| parentId |
Long |
可选 |
父级类别ID |
| organizationId |
Integer |
必填 |
组织ID |
| sort |
Integer |
可选 |
排序 |
| description |
String |
可选 |
描述 |
| isActive |
Boolean |
可选 |
是否激活 |
响应字段
| 字段名 |
类型 |
描述 |
| Boolean |
Boolean |
操作结果,true表示成功,false表示失败 |
PUT /open/v1/purchaser/category - 更新物料类别
请求体:CategoryDTO
| 字段名 |
类型 |
必填 |
描述 |
| id |
Long |
必填 |
类别ID |
| categoryName |
String |
必填 |
类别名称 |
| categoryCode |
String |
必填 |
类别编码 |
| parentId |
Long |
可选 |
父级类别ID |
| organizationId |
Integer |
必填 |
组织ID |
| sort |
Integer |
可选 |
排序 |
| description |
String |
可选 |
描述 |
| isActive |
Boolean |
可选 |
是否激活 |
响应字段
| 字段名 |
类型 |
描述 |
| Boolean |
Boolean |
操作结果,true表示成功,false表示失败 |
DELETE /open/v1/purchaser/category/{id} - 删除物料类别
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| id |
Long |
必填 |
类别ID |
响应字段
| 字段名 |
类型 |
描述 |
| Boolean |
Boolean |
操作结果,true表示成功,false表示失败 |
项目API (/open/v1/project)
GET /open/v1/project/page - 项目分页查询
请求参数
| 参数名 |
类型 |
必填 |
描述 |
| pageNo |
long |
可选 |
页码,默认值:1 |
| pageSize |
long |
可选 |
每页数量,默认值:10 |
| start |
Date |
可选 |
开始时间,格式:yyyy-MM-dd |
| end |
Date |
可选 |
结束时间,格式:yyyy-MM-dd |
| name |
String |
可选 |
项目名称 |
响应对象:Project
| 字段名 |
类型 |
描述 |
| id |
Integer |
项目ID |
| name |
String |
项目名称 |
| organizationId |
Integer |
组织ID |
| teamId |
Integer |
团队ID |
| description |
String |
项目描述 |
| status |
String |
项目状态 |
| projectLeader |
Integer |
项目负责人ID |
| projectLeaderUser |
User |
项目负责人信息 |
| projectMember |
String |
项目成员ID字符串,逗号分隔 |
| projectMembers |
List<User> |
项目成员列表 |
| projectBudget |
BigDecimal |
项目预算 |
| projectStart |
Date |
项目开始日期 |
| projectEnd |
Date |
项目结束日期 |
| createdBy |
Integer |
创建者ID |
| createdAt |
Date |
创建时间 |
| updatedAt |
Date |
更新时间 |
| purchaserId |
Integer |
采购商ID |
GET /open/v1/project/{projectId} - 查询项目详情
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| projectId |
Integer |
必填 |
项目ID |
响应对象:Project
| 字段名 |
类型 |
描述 |
| id |
Integer |
项目ID |
| name |
String |
项目名称 |
| organizationId |
Integer |
组织ID |
| teamId |
Integer |
团队ID |
| description |
String |
项目描述 |
| status |
String |
项目状态 |
| projectLeader |
Integer |
项目负责人ID |
| projectLeaderUser |
User |
项目负责人信息 |
| projectMember |
String |
项目成员ID字符串,逗号分隔 |
| projectMembers |
List<User> |
项目成员列表 |
| projectBudget |
BigDecimal |
项目预算 |
| projectStart |
Date |
项目开始日期 |
| projectEnd |
Date |
项目结束日期 |
| createdBy |
Integer |
创建者ID |
| createdAt |
Date |
创建时间 |
| updatedAt |
Date |
更新时间 |
| purchaserId |
Integer |
采购商ID |
询价API (/open/v1/purchase)
POST /open/v1/purchase/pre-purchase-import - 导入采购申请
请求体:PurchaseApplicationDTO
| 字段名 |
类型 |
必填 |
描述 |
| purchaseReason |
String |
必填 |
采购事由 |
| expectedDeliveryTime |
Date |
必填 |
期望交付时间 |
| applicant |
String |
必填 |
申请人-登录账号 |
| organizationId |
Integer |
必填 |
组织ID |
| clientApplicationNo |
String |
必填 |
调用方的申请单号 |
| applicationLists |
List<PurchaseApplicationItemDTO> |
必填 |
采购申请项列表 |
请求体内部对象:PurchaseApplicationItemDTO
| 字段名 |
类型 |
必填 |
描述 |
| projectId |
Integer |
必填 |
项目ID |
| itemCode |
String |
必填 |
物料编码 |
| approvedQuantity |
BigDecimal |
必填 |
批准量 |
| remarks |
String |
必填 |
备注 |
| warehouseId |
Integer |
必填 |
仓库ID |
| extendFields |
Map<String, Object> |
必填 |
扩展字段 |
响应对象:PurchaseApplication
| 字段名 |
类型 |
描述 |
| id |
Integer |
申请单ID |
| applicationNo |
String |
申请单号 |
| purchaseReason |
String |
采购事由 |
| expectedDeliveryTime |
Date |
期望交付时间 |
| applicant |
String |
申请人 |
| organizationId |
Integer |
组织ID |
| status |
String |
申请单状态 |
| createdAt |
Date |
创建时间 |
| updatedAt |
Date |
更新时间 |
| clientApplicationNo |
String |
客户端申请单号 |
PUT /open/v1/purchase/pre-purchase-import/{clientApplicationNo} - 更新导入的采购申请
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| clientApplicationNo |
String |
必填 |
客户端申请编号 |
请求体:PurchaseApplicationDTO
| 字段名 |
类型 |
必填 |
描述 |
| purchaseReason |
String |
必填 |
采购事由 |
| expectedDeliveryTime |
Date |
必填 |
期望交付时间 |
| applicant |
String |
必填 |
申请人-登录账号 |
| organizationId |
Integer |
必填 |
组织ID |
| clientApplicationNo |
String |
必填 |
调用方的申请单号 |
| applicationLists |
List<PurchaseApplicationItemDTO> |
必填 |
采购申请项列表 |
请求体内部对象:PurchaseApplicationItemDTO
| 字段名 |
类型 |
必填 |
描述 |
| projectId |
Integer |
必填 |
项目ID |
| itemCode |
String |
必填 |
物料编码 |
| approvedQuantity |
BigDecimal |
必填 |
批准量 |
| remarks |
String |
必填 |
备注 |
| warehouseId |
Integer |
必填 |
仓库ID |
| extendFields |
Map<String, Object> |
必填 |
扩展字段 |
响应对象:PurchaseApplication
| 字段名 |
类型 |
描述 |
| id |
Integer |
申请单ID |
| applicationNo |
String |
申请单号 |
| purchaseReason |
String |
采购事由 |
| expectedDeliveryTime |
Date |
期望交付时间 |
| applicant |
String |
申请人 |
| organizationId |
Integer |
组织ID |
| status |
String |
申请单状态 |
| createdAt |
Date |
创建时间 |
| updatedAt |
Date |
更新时间 |
| clientApplicationNo |
String |
客户端申请单号 |
采购商品API (/open/v1/purchaser)
POST /open/v1/purchaser/product - 创建物料信息
请求体:PurchaserProductDTO
| 字段名 |
类型 |
必填 |
描述 |
| organizationId |
Integer |
必填 |
组织ID |
| productName |
String |
必填 |
商品名称 |
| category |
Integer |
category/categoryCode 二选一 |
分类ID |
| categoryCode |
Integer |
category/categoryCode 二选一 |
分类编码 |
| specification |
String |
必填 |
规格型号 |
| code |
String |
必填 |
编码 |
| unit |
String |
必填 |
单位 |
| remarks |
String |
|
备注 |
| brand |
String |
|
品牌 |
响应字段
| 字段名 |
类型 |
描述 |
| Boolean |
Boolean |
操作结果,true表示成功,false表示失败 |
PUT /open/v1/purchaser/product/{productCode} - 修改物料信息
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| productCode |
String |
必填 |
产品编码 |
请求体:PurchaserProductDTO
| 字段名 |
类型 |
必填 |
描述 |
| productName |
String |
可选 |
商品名称 |
| category |
Integer |
可选 |
分类ID |
| categoryCode |
Integer |
可选 |
分类编码 |
| specification |
String |
可选 |
规格型号 |
| code |
String |
可选 |
编码 |
| unit |
String |
可选 |
单位 |
| remarks |
String |
可选 |
备注 |
| brand |
String |
可选 |
品牌 |
响应字段
| 字段名 |
类型 |
描述 |
| Boolean |
Boolean |
操作结果,true表示成功,false表示失败 |
DELETE /open/v1/purchaser/product/{productCode} - 删除商品信息
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| productCode |
String |
必填 |
产品编码 |
响应字段
| 字段名 |
类型 |
描述 |
| Boolean |
Boolean |
操作结果,true表示成功,false表示失败 |
结算单API (/open/v1/settlement)
GET /open/v1/settlement - 分页查询结算单
请求参数
| 参数名 |
类型 |
必填 |
描述 |
| pageNo |
Integer |
可选 |
页码,默认值:1 |
| pageSize |
Integer |
可选 |
每页数量,默认值:10 |
| status |
String |
可选 |
结算单组织状态 |
| invoiceStatus |
String |
可选 |
发票状态 |
| paymentStatus |
String |
可选 |
支付状态 |
响应对象:Settlement
| 字段名 |
类型 |
描述 |
| id |
Integer |
结算单ID |
| organizationId |
Integer |
组织ID |
| supplierId |
Integer |
供应商ID |
| supplierName |
String |
供应商名称 |
| purchaserName |
String |
采购商名称 |
| settlementNo |
String |
结算单号 |
| amount |
BigDecimal |
金额 |
| invoiceInfoId |
Integer |
发票信息ID |
| invoiceInfo |
InvoiceInfo |
发票信息 |
| supplierReceivableAccountId |
Integer |
供应商收款账户ID |
| supplierReceivableAccount |
SupplierReceivableAccount |
供应商收款账户 |
| invoiceType |
String |
发票类型 |
| invoiceStatus |
String |
发票状态 |
| invoiceTime |
Date |
发票时间 |
| invoiceUserId |
Integer |
发票处理用户ID |
| paymentStatus |
String |
支付状态 |
| paymentTime |
Date |
支付时间 |
| paymentUserId |
Integer |
支付用户ID |
| createdAt |
Date |
创建时间 |
| updatedAt |
Date |
更新时间 |
| creatorId |
Integer |
创建者ID |
| creator |
User |
创建者信息 |
| orders |
List<OrderInfo> |
订单列表 |
| supplierContact |
SupplierPurchaserInvitation |
供应商联系信息 |
| purchaserId |
Integer |
采购商ID |
| status |
String |
状态 |
响应对象内部结构:
SupplierReceivableAccount 对象结构:
| 字段名 |
类型 |
描述 |
| id |
Long |
自增主键 |
| enterpriseFullName |
String |
企业全称,与营业执照严格一致 |
| bankName |
String |
开户银行,含支行全称 |
| bankAccount |
String |
银行账号 |
| createdAt |
Date |
创建时间 |
| updatedAt |
Date |
更新时间 |
| supplierId |
Integer |
供应商ID |
| contactName |
String |
联系人姓名 |
| contactPhone |
String |
联系人电话 |
| isDefault |
Boolean |
是否为默认账户 |
SupplierPurchaserInvitation 对象结构:
| 字段名 |
类型 |
描述 |
| id |
Integer |
主键ID |
| organizationId |
Integer |
采购方组织ID |
| supplierId |
Integer |
供应商ID |
| userId |
Integer |
供应商用户ID |
| inviterId |
Integer |
邀请人ID |
| invitationTime |
Date |
邀请时间 |
| organization |
Organization |
组织信息 |
| supplier |
Supplier |
供应商信息 |
| user |
SupplierUser |
供应商用户信息 |
| inviter |
User |
邀请人信息 |
| contactPerson |
String |
联系人姓名 |
| contactPhone |
String |
联系电话 |
| email |
String |
邮箱地址 |
| address |
String |
地址 |
| creditRating |
Byte |
信用等级 |
| isActive |
String |
是否激活 |
| bankAccount |
String |
银行账户 |
| isDeleted |
Integer |
是否删除 |
| purchaserId |
Integer |
采购商ID |
GET /open/v1/settlement/download/{settlementNo}/invoice - 下载发票
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| settlementNo |
String |
必填 |
结算单编号 |
响应字段
| 字段名 |
类型 |
描述 |
| String |
String |
发票临时下载链接 |
GET /open/v1/settlement/{settlementNo}/invoice - 查询发票
路径参数
| 参数名 |
类型 |
必填 |
描述 |
| settlementNo |
String |
必填 |
结算单编号 |
响应字段
| 字段名 |
类型 |
描述 |
| String |
String |
结算单详情信息 |
仓库API (/open/v1/warehouse)
GET /open/v1/warehouse/page - 获取仓库列表
请求参数
| 参数名 |
类型 |
必填 |
描述 |
| page |
Integer |
可选 |
页码,默认值:1 |
| size |
Integer |
可选 |
每页数量,默认值:10 |
| name |
String |
可选 |
仓库名称 |
| status |
Boolean |
可选 |
状态 |
响应对象:PurchaserWarehouseVO
| 字段名 |
类型 |
描述 |
| id |
Integer |
仓库ID |
| name |
String |
仓库名称 |
| isBind |
Boolean |
是否绑定 |
| recipients |
List<String> |
收件人列表 |
异常编码说明
本节列出了开放API接口中可能返回的所有异常编码及其说明。所有API响应都遵循统一的响应格式,包含code(状态码)、message(错误信息)等字段。
响应格式
所有API响应都采用以下JSON格式:
{
"code": 20200,
"message": "Request Success",
"data": { ... }
}
异常编码列表
| 错误码 |
错误名称 |
错误信息 |
使用场景 |
| 20200 |
SUCCESS |
Request Success |
请求成功,所有API成功响应时返回此状态码 |
| 20401 |
UNAUTHORIZED |
没有权限 |
认证失败,用户未登录或token无效时返回 |
| 20402 |
PARAM_ERROR |
参数错误 |
请求参数缺失、格式错误或不符合要求时返回。例如:必填参数为空、参数类型错误、参数值超出范围等 |
| 20403 |
FORBIDDEN_ERROR |
请求被拒 |
请求被拒绝,通常由于安全策略或权限不足 |
| 20404 |
OVER_AUTHORIZED |
参数越权 |
尝试访问或操作不属于当前用户/组织的资源时返回 |
| 20422 |
USER_UNPROCESSABLE |
用户信息有误,请确认信息是否已经注册过其他用户 |
用户信息处理失败,通常在用户注册或更新时发生 |
| 20500 |
INTERNAL_ERROR |
Internal Error |
服务器内部错误,系统异常时返回 |
| 20501 |
DATA_CONFLICT |
数据冲突 |
数据冲突,例如:商品编码重复、唯一性约束冲突等 |
| 20502 |
DATA_NOT_FOUND |
数据不存在 |
请求的数据不存在,例如:根据编码查询商品时未找到对应记录 |
| 20503 |
LICENSE_ERROR |
图片解析失败,请重新上传 |
营业执照图片解析失败,图片格式不正确或无法识别 |
| 20504 |
LICENSE_EXIST_ERROR |
营业执照信息不存在 |
根据统一社会信用代码查询营业执照信息时未找到记录 |
| 20505 |
EXCEL_ERROR |
excel解析失败 |
Excel文件解析失败,文件格式错误或内容不符合要求 |
| 20506 |
INVITE_ERROR |
邀请码错误 |
邀请码不存在或已失效 |
| 20507 |
EXPRESS_ERROR |
快递信息获取失败 |
查询快递物流信息时失败 |
| 20508 |
INVOICE_ERROR |
发票识别失败 |
发票图片识别失败,图片格式不正确或无法识别发票信息 |
| 20509 |
CANCEL_ERROR |
取消失败 |
取消操作失败,例如:订单状态不允许取消 |
常见错误处理建议
- 20402 参数错误:请检查请求参数是否完整,参数类型和格式是否正确。参考各接口的参数说明,确保必填参数都已提供。
- 20401 没有权限:请确认已正确传递认证token,且token未过期。
- 20501 数据冲突:通常是唯一性约束冲突,如商品编码重复,请使用不同的编码重试。
- 20502 数据不存在:请确认查询的资源ID或编码是否正确,资源是否已被删除。
- 20500 服务器内部错误:系统异常,请联系技术支持或稍后重试。