业务接口¶

供应商管理相关接口

根据编号查询商户供应商
erp编号查询供应商
商户的所有供应商（分页查询）
新增供应商
更新供应商基础信息
商户解除供应商

部门维护接口

增加部门
获取所有部门

订单相关接口

创建采购订单
采购订单推送

物料维护相关接口

物料基础信息
根据erp_code查询物料基础信息
添加物料
更新物料基础信息
移除物料
查询所有物料(分页查询)
查询物料分类

库存相关接口

销售出库

供应商开放接口¶

根据ID查询供应商¶

根据ID查询供应商

请求地址¶

/suppliers/{supplierId}

HTTP方法¶

GET

URL参数¶

无

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	供应商基础信息	可空	返回供应商基础信息
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

Suppler: 供应商基础信息

返回示例¶

{
        "code": 200,
        "data": {
                "supplierId": 6000410,  #供应商ID
                "name": "测试",   #供应商简称
                "fullName": "测试-餐启",    #供应商全称
                "phone": "15212349910", #       供应商手机号
                "pinyin": "cscq",       #供应商简拼
                "contacts": "15212349910",      #联系人
                "representative": "test",       #       营业法人
                "businessLicense": "123456789", #       营业执照
                "bankAccountCode": null,        #银行账号
                "bankAccountName": null,        #       银行账号账户名
                "bankBranch": null,     #银行分支机构
                "bankName": null,       #       银行名称
                "note": ""      #备注
        },
        "message": null,
        "error": null
}

根据erpcode查询供应商¶

根据erpcode查询供应商

请求地址¶

/suppliers/erpcode/{erpcode}

HTTP方法¶

GET

URL参数¶

无

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	供应商基础信息	可空	返回供应商基础信息
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

Suppler: 供应商基础信息

返回示例¶

{
        "code": 200,
        "data": {
                "supplierId": 6000410,  #供应商ID
                "name": "测试",   #供应商简称
                "fullName": "测试-餐启",    #供应商全称
                "phone": "15212349910", #       供应商手机号
                "pinyin": "cscq",       #供应商简拼
                "contacts": "15212349910",      #联系人
                "representative": "test",       #       营业法人
                "businessLicense": "123456789", #       营业执照
                "bankAccountCode": null,        #银行账号
                "bankAccountName": null,        #       银行账号账户名
                "bankBranch": null,     #银行分支机构
                "bankName": null,       #       银行名称
                "note": ""      #备注
        },
        "message": null,
        "error": null
}

查询所有供应商(分页查询)¶

查询所有供应商

请求地址¶

/suppliers

HTTP方法¶

GET

URL参数¶

参数名	类型	是否必须	描述
pageIndex	int	可空	第几页，默认是第一页开始
pagesize	int	可空	每页数据条数，每页默认不能超过20条
begin	string	可空	最后更新时间范围的开始
end	string	可空	最后更新时间范围的结束

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	Page<Supplier>	可空	供应商基础信息集合
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

Page<Supplier>

名称	类型	可空	描述
pageNum	int	非空	当前页数
datas	[Supplier]	可空	物料信息集合
pageSize	string	非空	分页每页条数
total	string	非空	数据总条数
pages	int	非空	分页总页数

供应商基础信息¶

供应商基础信息(Supplier)¶
名称	类型	可空	描述
supplierId	long	非空	供应商ID
name	stirng	非空	供应商简称
fullName	string	非空	供应商全称
phone	string	非空	供应商手机号
pinyin	string	可空	供应商简拼
contacts	string	可空	联系人
representative	string	可空	营业法人
businessLicense	string	可空	营业执照
bankAccountCode	string	可空	银行账号
bankAccountName	string	可空	银行账号账户名
bankBranch	string	可空	银行分支机构
bankName	string	可空	银行名称
note	string	可空	备注
erpCode	string	可空	第三方编码

返回示例¶

{
        "code": 200,
        "data": {
                "pageNum": 1,
                "pageSize": 2,
                "total": 38,
                "pages": 19,
                "datas": [{
                        "supplierId": 6044209,#供应商ID
                        "name": "法海食品店7020007",#供应商简称
                        "fullName": "法海食品店7020007",     #供应商全称
                        "phone": "13974852608", #       供应商手机号
                        "pinyin": "fhspd7020007",       #供应商简拼
                        "contacts": "任白海",      #联系人
                        "representative": "",   #       营业法人
                        "businessLicense": "",  #       营业执照
                        "bankAccountCode": null,        #银行账号
                        "bankAccountName": null,        #       银行账号账户名
                        "bankBranch": null,     #银行分支机构
                        "bankName": null,       #       银行名称
                        "note": "系统导入"  #备注
                }, {
                        "supplierId": 6044211,
                        "name": "蒋红旗（酒鬼内参）7020011",
                        "fullName": "蒋红旗（酒鬼内参）7020011",
                        "phone": "13142019059",
                        "pinyin": "jhqjgnc7020011",
                        "contacts": "蒋红旗",
                        "representative": "",
                        "businessLicense": "",
                        "bankAccountCode": null,
                        "bankAccountName": null,
                        "bankBranch": null,
                        "bankName": null,
                        "note": "系统导入"
                }]
        },
        "message": null,
        "error": null
}

新增供应商¶

商户添加供应商

请求地址¶

/suppliers

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
name	stirng	非空	供应商简称
fullName	string	非空	供应商全称
phone	string	非空	供应商手机号
pinyin	string	可空	供应商简拼
contacts	string	可空	联系人
representative	string	可空	营业法人
businessLicense	string	非空	营业执照
bankAccountCode	string	可空	银行账号
bankAccountName	string	可空	银行账号账户名
bankBranch	string	可空	银行分支机构
bankName	string	可空	银行名称
note	string	可空	备注
erpCode	string	可空	erp编号

请求示例¶

{
        "name": "肉类供应商",
        "fullName": "肉类供应商",
        "phone": "13812341111",
        "pinyin": "nlgys",
        "contacts": "张三",
        "representative": "李四",
        "businessLicense": "11",
        "bankAccountCode": "88",
        "bankAccountName": "88",
        "bankBranch": "11",
        "bankName": "11",
        "note": "11",
        "erpCode": "erpcode"
}

请求示例¶

{
    "name": "分区啤酒类6",  # 物料分类名称
    "pinyin": "1231111",  # 分类拼音
    "parentId": 456,  # 分类父id 默认0
    "parentErpCode":1, # 分类父编码
    "categoryId": 1,  # 科目 1原材料,2易耗品
    "isPurchase": 1,  # 是否可采购 1 可采购
    "erpCode": "123",  # 物料分类erpCode
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	IdKey	非空	返回新增的供应商的主键标识
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

IdKey

名称	类型	是否必须	描述
id	string	非空	主键ID

返回示例¶

{
"code": 200,
"data": {
        "id": "6001089"
},
"message": null,
"error": null
}

修改供应商基础信息¶

修改供应商基础信息:

请求地址¶

/suppliers/{supplierId}

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
name	stirng	非空	供应商简称
fullName	string	非空	供应商全称
phone	string	非空	供应商手机号
pinyin	string	可空	供应商简拼
contacts	string	可空	联系人
representative	string	可空	营业法人
businessLicense	string	非空	营业执照
bankAccountCode	string	可空	银行账号
bankAccountName	string	可空	银行账号账户名
bankBranch	string	可空	银行分支机构
bankName	string	可空	银行名称
note	string	可空	备注
erpCode	string	可空	ERP编号

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	null	空
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
"code": 200,
"data": null,
"message": "修改成功",
"error": null
}

商户解除供应商¶

商户解除供应商

请求地址¶

/suppliers/{supplierId}

HTTP方法¶

DELETE

URL参数¶

无

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	null	空
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
    "code": 200,
    "data": null,
    "message": "删除成功",
    "error": null
}

根据时间段查询销售单¶

根据时间段查询销售单

请求地址¶

/suppliers/listSalesOrder

HTTP方法¶

GET

URL参数¶

参数名	类型	是否必须	描述
begin	string	必须	查询时间范围的开始(格式：yyyy-MM-dd HH:mm:ss)
end	string	必须	查询时间范围的结束(格式：yyyy-MM-dd HH:mm:ss)

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	[SalesOrder销售单]	非空
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

SalesOrder销售单¶

名称	类型	可空	描述
id	long	非空	销售单ID
code	stirng	非空	供应商(卖方)销售单号
customerOrderCode	string	非空	买方采购单号
customerId	long	非空	买方租户ID
customerName	string	非空	买方租户名称
customerErpCode	string	可空	买方租户ErpCode
customerBranchId	Long	非空	买方门店ID
customerBranchName	string	非空	买方门店名称
customerBranchErpCode	string	非空	买方门店第三方编码
statusId	long	非空	状态ID(1:未确认 2:已确认 3:配货中 4:已配货 5:已完成 6:已取消 99:已过期)
statusText	string	非空	状态名称
amount	BigDecimal	非空	销售总价
taxAmount	BigDecimal	可空	含税金额
tax	BigDecimal	可空	税金
createdDate	string	非空	创建时间
deliveryTime	string	非空	要求到货时间
purchaseOrderErpCode	string	可空	买方采购单第三方编码
details	[OrderDetail销售单明细]	可空	销售单明细

OrderDetail销售单明细¶

名称	类型	描述
id	long	销售明细ID
documenId	long	销售单主单ID
customerDepartmentId	long	买方部门id
customerDepartmentName	string	买方部门名称
customerDepartmentErpCode	long	买方部门第三方编码
materialId	long	买方物料id
materialName	long	买方物料名称
materialErpCode	long	买方物料第三方编码
unitId	long	采购单位id
unitName	string	采购单位名称
quantity	Bigdecimal	采购单位数量
price	Bigdecimal	单价
secondUnitId	long	收货单位id
secondUnitName	string	收货单位名称
secondQuantity	Bigdecimal	收货单位数量
amount	Bigdecimal	总价
taxAmount	BigDecimal	含税金额
tax	BigDecimal	税金
taxRate	BigDecimal	税率
taxPrice	BigDecimal	含税单价
purchaseDetailErpCode	Bigdecimal	买方订单明细第三方编码
spec	String	规格

返回示例¶

{
    "code": 200,
    "data": [
        {
            "id": 7499414,      # 销售单ID
            "code": "XS1812177499414",  # 供应商(卖方)销售单号
            "customerOrderCode": "CG1812177435706", # 买方采购单号
            "customerId": 6118743,  # 买方租户ID
            "customerName": "易迅",   # 买方租户名称
            "customerErpCode": null,    # 买方租户第三方编码
            "customerBranchId": 6088133,    # 买方门店ID
            "customerBranchName": "易迅一号门店",     # 买方门店名称
            "customerBranchErpCode": "",    # 买方门店第三方编码
            "statusId": 5,  # 状态ID(1:未确认 2:已确认 3:配货中 4:已配货 5:已完成 6:已取消 99:已过期)
            "statusText": "已完成",    # 状态名称
            "amount": 0,    # 销售总价
            "createdDate": "2018-12-17 16:47:47",   # 创建时间
            "purchaseOrderErpCode": "6006000",  # 买方采购单第三方编码
            "details": [
                {
                    "id": 16361020,     # 销售明细ID
                    "documentId": 7499414,      # 销售单主单ID
                    "customerDepartmentId": 6116033,    # 买方部门id
                    "customerDepartmentName": "自动档口10001",  # 买方部门名称
                    "customerDepartmentErpCode": "10001",   # 买方部门第三方编码
                    "materialId": 8245977,  # 买方物料id
                    "materialName": "自动003",    # 买方物料名称
                    "materialErpCode": "6006005",   # 买方物料第三方编码
                    "unitId": 42,   # 采购单位id
                    "unitName": "斤",    # 采购单位名称
                    "quantity": 5,  # 采购单位数量
                    "price": 0, # 单价
                    "secondUnitId": 42, # 收货单位id
                    "secondUnitName": "斤",  # 收货单位名称
                    "secondQuantity": 5,    # 收货单位数量
                    "amount": 0,    # 总价
                    "purchaseDetailErpCode": "7001" # 买方订单明细第三方编码
                }
            ]
        }
    ],
    "message": null,
    "error": null
}

查询销售单¶

查询销售单

请求地址¶

/suppliers/listSalesOrder

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

SalesOrderParam对象¶
名称	类型	是否必须	描述
begin	string	非空	查询时间范围的开始(格式：yyyy-MM-dd HH:mm:ss)
end	string	非空	查询时间范围的结束(格式：yyyy-MM-dd HH:mm:ss)
salesOrderIds	List<Long>	可空	销售订单id集合
salesOrderCodes	List<string>	可空	销售订单编号集合
customerIds	List<Long>	可空	客户id
customerTenantIds	List<Long>	可空	客户租户id
customerBranchIds	List<Long>	可空	客户门店id
customerBuyerBranchIds	List<Long>	可空	客户餐厅门店id
statusIds	List<int>	可空	订单状态[SalesOrderState销售单状态]

SalesOrderState销售单状态¶

值	描述
1	未确认
2	已确认
3	配货中
4	已配货
5	已完成

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	[SalesOrder销售单]	非空
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
    "code": 200,
    "data": [
        {
            "id": 7499414,      # 销售单ID
            "code": "XS1812177499414",  # 供应商(卖方)销售单号
            "customerOrderCode": "CG1812177435706", # 买方采购单号
            "customerId": 6118743,  # 买方租户ID
            "customerName": "易迅",   # 买方租户名称
            "customerErpCode": null,    # 买方租户第三方编码
            "customerBranchId": 6088133,    # 买方门店ID
            "customerBranchName": "易迅一号门店",     # 买方门店名称
            "customerBranchErpCode": "",    # 买方门店第三方编码
            "statusId": 5,  # 状态ID(1:未确认 2:已确认 3:配货中 4:已配货 5:已完成 6:已取消 99:已过期)
            "statusText": "已完成",    # 状态名称
            "amount": 0,    # 销售总价
            "createdDate": "2018-12-17 16:47:47",   # 创建时间
            "purchaseOrderErpCode": "6006000",  # 买方采购单第三方编码
            "details": [
                {
                    "id": 16361020,     # 销售明细ID
                    "documentId": 7499414,      # 销售单主单ID
                    "customerDepartmentId": 6116033,    # 买方部门id
                    "customerDepartmentName": "自动档口10001",  # 买方部门名称
                    "customerDepartmentErpCode": "10001",   # 买方部门第三方编码
                    "materialId": 8245977,  # 买方物料id
                    "materialName": "自动003",    # 买方物料名称
                    "materialErpCode": "6006005",   # 买方物料第三方编码
                    "unitId": 42,   # 采购单位id
                    "unitName": "斤",    # 采购单位名称
                    "quantity": 5,  # 采购单位数量
                    "price": 0, # 单价
                    "secondUnitId": 42, # 收货单位id
                    "secondUnitName": "斤",  # 收货单位名称
                    "secondQuantity": 5,    # 收货单位数量
                    "amount": 0,    # 总价
                    "purchaseDetailErpCode": "7001" # 买方订单明细第三方编码
                }
            ]
        }
    ],
    "message": null,
    "error": null
}

根据时间段查询退货单¶

根据时间段查询退货单

请求地址¶

/suppliers/listSalesReturn

HTTP方法¶

GET

URL参数¶

参数名	类型	是否必须	描述
begin	string	必须	查询时间范围的开始
end	string	必须	查询时间范围的结束

Response Json Body¶

SalesReturn退货单¶

名称	类型	可空	描述
id	long	非空	退货单ID
code	stirng	非空	供应商(卖方)退货单号
customerCode	string	非空	买方退货单号
customerId	long	非空	买方租户ID
customerName	string	非空	买方租户名称
customerErpCode	string	可空	买方租户ErpCode
customerBranchId	Long	非空	买方门店ID
customerBranchName	string	非空	买方门店名称
customerBranchErpCode	string	非空	买方门店第三方编码
customerReturnId	string	非空	买方退货人id
customerReturner	string	非空	买方退货人名称
customerReturnErpCode	string	非空	买方退货人第三方编码
modifierId	string	非空	操作人id
modifierName	string	非空	操作人名称
statusId	long	非空	状态ID(1:已创建 2:已确认 3:客户已确认 4:已完成 5:已取消 6:已核帐)
statusText	string	非空	状态名称
amount	BigDecimal	非空	退货总价
taxAmount	BigDecimal	可空	含税金额
tax	BigDecimal	可空	税金
createdDate	string	非空	创建时间
customerReturnId	long	非空	买方退货单ID
customerReturnErpCode	string	可空	买方退货单第三方编码
returnType	int	可空	退货类型，1退货退款、2仅退货、3换货
businessId	long	可空	退货来源销售订单id
businessCode	string	可空	退货来源销售订单编码
businessDetailId	long	可空	退货来源销售订单明细id
details	[ReturnDetail退货单明细]	可空	退货明细

ReturnDetail退货单明细¶

名称类型描述

id long 退货明细ID

documentId long 退货单ID

customerDepartmentId long 买方部门id

customerDepartmentName string 买方部门名称

customerDepartmentErpCode long 买方部门第三方编码

materialId long 买方物料id

materialName long 买方物料名称

materialErpCode long 买方物料第三方编码

unitId long 收货单位id

unitName string 收货单位名称

quantity Bigdecimal 收货单位数量

unitIdOfInventory long 库存单位id

unitNameOfInventory string 库存单位名称

quantityOfInventory Bigdecimal 库存单位数量

unitIdOfOrder long 采购单位id

unitNameOfOrder string 采购单位名称

quantityOfOrder Bigdecimal 采购单位数量

price Bigdecimal 单价

amount Bigdecimal 总价

taxAmount BigDecimal 含税金额

tax BigDecimal 税金

taxRate BigDecimal 税率

taxPrice BigDecimal 含税单价

returnAmount Bigdecimal 退货总金额

customerDetailErpCode Bigdecimal 买方退货明细第三方编码

reason string 退货原因

detailNote string 退货明细备注

customerDetailNote string 客户退货明细备注

imgs List<string> 退货图片

statusId long 状态ID(1:已创建 2:已确认 6:已取消)

statusText string 状态名称

返回示例¶

{
    "code": 200,
    "data": [
        {
            "id": 6110479,  # 退货单ID
            "code": "XSTH1812146110479",    # 供应商(卖方)退货单号
            "customerCode": "CGTH1812146110499",    # 买方退货单号
            "customerId": 6118743,  # 买方租户ID
            "customerName": "易迅",   # 买方租户名称
            "customerErpCode": null,    #   买方租户ErpCode
            "customerBranchId": 6088133,    # 买方门店ID
            "customerBranchName": "易迅一号门店", # 买方门店名称
            "customerBranchErpCode": "",    # 买方门店第三方编码
            "customerReturner": "易迅",   # 买方退货人id
            "modifierId": 6131736,  # 操作人id
            "modifierName": "易迅",   # 操作人名称
            "statusId": 1,  # 状态ID(1:已创建 2:已确认 3:客户已确认 4:已完成 5:已取消 6:已核帐)
            "statusText": "已创建",    # 状态名称
            "amount": 66,   # 退货总价
            "createdDate": "2018-12-14 14:10:47",   # 创建时间
            "customerReturnId": 6110499,    # 买方退货单号
            "customerReturnErpCode": "",    # 买方退货单第三方编码
            "details": [
                {
                    "id": 6100046,  # 退货明细ID
                    "documentId": 6110479,  # 退货主单ID
                    "customerDepartmentId": 6116036,    # 买方部门id
                    "customerDepartmentName": "自动档口100041", # 买方部门名称
                    "customerDetailErpCode": null,  # 买方部门第三方编码
                    "materialId": 8230256,    # 买方物料id
                    "materialName": "白砂糖",  # 买方物料名称
                    "mateiralErpCode": null,    #   买方物料第三方编码
                    "unitId": 43,   # 收货单位id
                    "unitName": "公斤",   #   收货单位名称
                    "quantity": 5,  #       收货单位数量
                    "unitIdOfInventory": 43,    # 库存单位id
                    "unitNameOfInventory": "公斤",    # 库存单位名称
                    "quantityOfInventory": 5,   # 库存单位数量
                    "unitIdOfOrder": 43,    #   采购单位ID
                    "unitNameOfOrder": "公斤",    # 采购单位名称
                    "quantityOfOrder": 5,   # 采购单位数量
                    "price": 0, # 单价
                    "amount": 0,    # 总价
                    "returnAmount": 0,  # 退货总金额
                    "customerDepartmentErpCode": "10005",   # 买方退货明细第三方编码
                    "reason": "协议退货",
                    "statusId": 1,  # 状态ID(1:已创建 2:已确认 6:已取消)
                    "statusText": "已创建"
                }
            ]
        }
    ],
    "message": null,
    "error": null
}

根据时间段查询交货账单¶

根据时间段查询供应商交货账单，交货单即账单

请求地址¶

/suppliers/delivery/list

HTTP方法¶

GET

URL参数¶

参数名	类型	是否必须	描述
begin	string	必须	查询时间范围的开始
end	string	必须	查询时间范围的结束

Response Json Body¶

SalesDelivery交货单¶

名称	类型	可空	描述
id	long	非空	交货单ID
code	string	非空	交货单编码
customerId	long	非空	买方租户ID
customerName	string	非空	买方租户名称
customerErpCode	string	可空	买方租户ErpCode
customerBranchId	Long	非空	买方门店ID
customerBranchName	string	非空	买方门店名称
customerBranchErpCode	string	可空	买方门店第三方编码
statusId	long	非空	状态ID(10:已创建 1:已配货 11:待配货 2:配货中 3:已配货 4:收货中 5:已记账 6:已核帐 7:已对账 8:已取消 9:已收货 99:已过期)
statusText	string	非空	状态名称
amount	BigDecimal	非空	退货总价
taxAmount	BigDecimal	可空	含税金额
tax	BigDecimal	可空	税金
senderName	string	可空	送货人
receiverName	string	可空	收货人
note	string	可空	备注
createdDate	string	非空	创建时间
modifiedDate	string	非空	最后更新时间
details	[SalesDeliveryDetail交货单明细]	可空	交货明细

SalesDeliveryDetail交货单明细¶

名称类型描述

id long 交货明细ID

documentId long 交货单ID

customerDepartmentId long 买方部门id

customerDepartmentName string 买方部门名称

customerDepartmentErpCode long 买方部门第三方编码

materialId long 买方物料id

supplierMaterialId long 卖方物料id

materialName long 买方物料名称

materialErpCode long 买方物料第三方编码

unitId long 采购单位id

unitName string 采购单位名称

secondUnitId long 收货单位id

secondUnitName string 收货单位名称

price Bigdecimal 收货单价

receiptedQuantity Bigdecimal 收货单位收货数量

amount Bigdecimal 金额

taxAmount BigDecimal 含税金额

tax BigDecimal 税金

taxRate BigDecimal 税率

taxPrice BigDecimal 含税单价

receiverDate string 收货时间

recordBillDate string 记账时间，对应买方账单的时间。比如一个交货单在9-30号跟10-1号各收了一部分，最终餐厅会把整个帐单的账期定为10-1号，所以9-30号收的部分也需要以10-1号对账

note string 备注

statusId long 状态ID(7:已创建 1:未配货 11:待确认配货 12:配货中 2:已配货 3:待补货 4:已完成 5:已取消 6:已收货 8:待出库 9:已出库 10:已核帐 13:已记帐)

statusText string 状态名称

spec string 规格

distributionQuantity Bigdecimal 采购单位发货数量

distributionQuantitySecond Bigdecimal 收货单位发货数量

receiptWeightRecordId long 称重id，相同id的明细表示为电子秤收货时一起称重收货

realWeight Bigdecimal 净重

tareWeight Bigdecimal 皮重

totalWeight Bigdecimal 总重

receiptWeightRecordInfo [ReceiptWeightRecordInfo称重信息] 称重信息

receiptAccumulativeRecordInfoList [ReceiptAccumulativeRecordInfo称重累加信息] 称重累加信息

ReceiptWeightRecordInfo称重信息¶

名称类型描述

receiptWeightRecordId long 称重id

realWeight Bigdecimal 净重

tareWeight Bigdecimal 皮重

totalWeight Bigdecimal 总重

weighDate date 称重时间

ReceiptAccumulativeRecordInfo称重累加信息¶

名称类型描述

receiptWeightRecordId long 称重id

realWeight Bigdecimal 净重

tareWeight Bigdecimal 皮重

totalWeight Bigdecimal 总重

accumulativeDate date 称重累加时间

iconPath string 累加图片地址

返回示例¶

{
    "code": 200,
    "data": [
        {
            "id": 18847227,
            "code": "22010418847227",
            "customerId": 6184411,
            "customerName": "大碗先生",
            "customerErpCode": null,
            "customerBranchId": 6108533,
            "customerBranchName": "大碗先生吾悦店",
            "customerBranchErpCode": "",
            "statusId": 6,
            "statusText": "已核帐",
            "amount": 6,
            "senderName": null,
            "receiverName": "-",
            "note": "-",
            "createdDate": "2022-01-04 11:20:58",
            "modifiedDate": "2022-01-04 11:21:11",
            "details": [
                {
                    "id": 81144003,
                    "documentId": 18847227,
                    "salesOrderDetailId": 81051425,
                    "customerDepartmentId": 6137929,
                    "customerDepartmentName": "后厨",
                    "customerDepartmentErpCode": null,
                    "statusId": 10,
                    "statusText": "已核帐",
                    "materialId": 11984624,
                    "supplierMaterialId": 0,
                    "materialName": "包菜",
                    "materialErpCode": "",
                    "secondUnitId": 42,
                    "secondUnitName": "斤",
                    "price": 6,
                    "receiptedQuantity": 1,
                    "amount": 6,
                    "receiverDate": "2022-01-04 11:21:11",
                    "recordBillDate": "2022-01-04 11:21:11",
                    "note": "",
                    "spec": ""
                }
            ]
        },
        {
            "id": 18847228,
            "code": "22010418847228",
            "customerId": 6184411,
            "customerName": "大碗先生",
            "customerErpCode": null,
            "customerBranchId": 6108533,
            "customerBranchName": "大碗先生吾悦店",
            "customerBranchErpCode": "",
            "statusId": 6,
            "statusText": "已核帐",
            "amount": 7,
            "senderName": null,
            "receiverName": "-",
            "note": "-",
            "createdDate": "2022-01-04 11:23:03",
            "modifiedDate": "2022-01-04 11:24:04",
            "details": [
                {
                    "id": 81144004,
                    "documentId": 18847228,
                    "salesOrderDetailId": 81051426,
                    "customerDepartmentId": 6137929,
                    "customerDepartmentName": "后厨",
                    "customerDepartmentErpCode": null,
                    "statusId": 10,
                    "statusText": "已核帐",
                    "materialId": 11984624,
                    "supplierMaterialId": 0,
                    "materialName": "包菜",
                    "materialErpCode": "",
                    "secondUnitId": 42,
                    "secondUnitName": "斤",
                    "price": 7,
                    "receiptedQuantity": 1,
                    "amount": 7,
                    "receiverDate": "2022-01-04 11:23:28",
                    "recordBillDate": "2022-01-04 11:23:28",
                    "note": "",
                    "spec": ""
                }
            ]
        },
        {
            "id": 18847229,
            "code": "22010418847229",
            "customerId": 6184411,
            "customerName": "大碗先生",
            "customerErpCode": null,
            "customerBranchId": 6108533,
            "customerBranchName": "大碗先生吾悦店",
            "customerBranchErpCode": "",
            "statusId": 6,
            "statusText": "已核帐",
            "amount": 14,
            "senderName": null,
            "receiverName": "-",
            "note": "-",
            "createdDate": "2022-01-04 11:23:28",
            "modifiedDate": "2022-01-04 11:24:14",
            "details": [
                {
                    "id": 81144005,
                    "documentId": 18847229,
                    "salesOrderDetailId": 81051427,
                    "customerDepartmentId": 6137929,
                    "customerDepartmentName": "后厨",
                    "customerDepartmentErpCode": null,
                    "statusId": 10,
                    "statusText": "已核帐",
                    "materialId": 11984624,
                    "supplierMaterialId": 0,
                    "materialName": "包菜",
                    "materialErpCode": "",
                    "secondUnitId": 42,
                    "secondUnitName": "斤",
                    "price": 7,
                    "receiptedQuantity": 2,
                    "amount": 14,
                    "receiverDate": "2022-01-04 11:23:39",
                    "recordBillDate": "2022-01-04 11:23:39",
                    "note": "",
                    "spec": ""
                }
            ]
        }
    ],
    "message": null,
    "error": null
}

获取客户¶

获取当前租户下的客户

请求地址¶

/suppliers/customer/list

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

CustomerParam对象¶
名称	类型	是否必须	描述
pageIndex	int	非空	当前页
pageSize	int	非空	每页大小，不能超过50

请求示例¶

{
    "pageIndex": 1, # 当前页 默认1
    "pageSize": 20 # 每页大小 默认20
}

Response Json Body¶

SalesCustomer客户信息¶

名称	类型	可空	描述
customerId	long	非空	客户id
tenantId	long	非空	租户id
name	string	非空	客户简称
fullName	string	非空	客户全称
statusId	int	非空	状态id，1正常2禁用
statusText	string	非空	状态描述
modifiedDate	date	非空	最后修改时间
note	string	可空	备注
customerTenantId	long	非空	客户租户id
contacts	string	可空	联系人
phone	string	可空	联系电话
provinceId	long	可空	省份id
provinceName	string	可空	省份名称
cityId	long	可空	城市id
cityName	string	可空	城市名称

返回示例¶

{
    "code": 200,
    "data": {
            "pageNum": 1,
            "pageSize": 50,
            "total": 3,
            "pages": 1,
            "datas": [
                {
                    "customerId": 61312821,
                    "tenantId": 61803421,
                    "name": "最好湘",
                    "fullName": "最好湘",
                    "statusId": 1,
                    "statusText": "启用",
                    "modifiedDate": 1636436168000,
                    "note": null,
                    "customerTenantId": 61112031,
                    "contacts": null,
                    "phone": null,
                    "provinceId": 50014,
                    "provinceName": "湖南省",
                    "cityId": 400142,
                    "cityName": "长沙市"
                },
                {
                    "customerId": 61326991,
                    "tenantId": 61803421,
                    "name": "总仓加工厂",
                    "fullName": "总仓加工厂",
                    "statusId": 1,
                    "statusText": "启用",
                    "modifiedDate": 1617782287000,
                    "note": "",
                    "customerTenantId": 61803421,
                    "contacts": "总仓",
                    "phone": "13548789941",
                    "provinceId": 50014,
                    "provinceName": "湖南省",
                    "cityId": 400142,
                    "cityName": "长沙市"
                }
            ]
        },
    "message": null,
    "error": null
}

获取客户门店¶

获取客户关联门店

请求地址¶

/suppliers/customer/branch/list

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

CustomerBranchParam对象¶
名称	类型	是否必须	描述
pageIndex	int	非空	当前页
pageSize	int	非空	每页大小，不能超过50
customerIds	List<Long>	可空	客户id集合筛选条件

请求示例¶

{
    "pageIndex": 1, # 当前页 默认1
    "pageSize": 20, # 每页大小 默认20
    "customerIds": [6000056,6000057] # 客户id集合筛选条件
}

Response Json Body¶

SalesCustomerBranch客户门店信息¶

名称	类型	可空	描述
customerBranchId	long	非空	客户门店id
tenantId	long	非空	租户id
customerId	long	非空	客户id
name	string	非空	客户简称
statusId	int	非空	状态id，1正常0禁用2删除
statusText	string	非空	状态描述
note	string	可空	备注
customerBuyerBranchId	long	非空	客户餐厅门店id
contacts	string	可空	联系人
phone	string	可空	联系电话
modifiedDate	date	非空	最后修改时间

返回示例¶

{
    "code": 200,
    "data": {
            "pageNum": 1,
            "pageSize": 50,
            "total": 4,
            "pages": 1,
            "datas": [
                {
                    "customerBranchId": 79934561,
                    "tenantId": 61803421,
                    "customerId": 61312821,
                    "name": "西郡店",
                    "statusId": 1,
                    "statusText": "启用",
                    "note": "",
                    "customerBuyerBranchId": 60861831,
                    "contacts": null,
                    "phone": null,
                    "modifiedDate": null
                },
                {
                    "customerBranchId": 79934571,
                    "tenantId": 61803421,
                    "customerId": 61312821,
                    "name": "信息港店",
                    "statusId": 1,
                    "statusText": "启用",
                    "note": "",
                    "customerBuyerBranchId": 60924881,
                    "contacts": null,
                    "phone": null,
                    "modifiedDate": null
                }
            ]
        },
    "message": null,
    "error": null
}

获取客户商品¶

获取客户关联商品

请求地址¶

/suppliers/customer/material/list

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

CustomerMaterialParam对象¶
名称	类型	是否必须	描述
pageIndex	int	非空	当前页
pageSize	int	非空	每页大小，不能超过50
customerIds	List<Long>	可空	客户id集合筛选条件
customerBranchIds	List<Long>	可空	客户门店id集合筛选条件

请求示例¶

{
    "pageIndex": 1, # 当前页 默认1
    "pageSize": 20, # 每页大小 默认20
    "customerIds": [6000056,6000057], # 客户id集合筛选条件
    "customerBranchIds": [6000056,6000057] # 客户门店id集合筛选条件
}

Response Json Body¶

SalesCustomerMaterial客户门店信息¶

名称	类型	可空	描述
tenantId	long	非空	租户id
customerId	long	非空	客户id
customerBranchId	long	非空	客户门店id
materialId	long	非空	物料id
materialName	string	非空	物料名称
materialSpec	string	可空	物料规格
materialPurchaseUnitId	int	非空	物料采购单位id
materialPurchaseUnitName	string	非空	物料采购单位名称
materialReceiptUnitId	int	非空	物料收货单位id
materialReceiptUnitName	string	非空	物料收货单位名称
materialErpCode	string	可空	物料erpcode
customerBuyerMaterialId	long	非空	客户物料id
customerBuyerMaterialName	string	非空	客户物料名称
customerBuyerMaterialSpec	string	可空	客户餐厅物料规格
customerBuyerMaterialPurchaseUnitId	int	非空	客户餐厅物料采购单位id
customerBuyerMaterialPurchaseUnitName	string	非空	客户餐厅物料采购单位名称
customerBuyerMaterialReceiptUnitId	int	非空	客户餐厅物料收货单位id
customerBuyerMaterialReceiptUnitName	string	非空	客户餐厅物料收货单位名称
customerBuyerMaterialErpCode	string	可空	客户餐厅物料erpcode
customerBuyerBranchId	long	非空	客户餐厅门店id

返回示例¶

{
    "code": 200,
    "data": {
            "pageNum": 1,
            "pageSize": 50,
            "total": 1050,
            "pages": 21,
            "datas": [
                {
                    "tenantId": 61803421,
                    "customerId": 61312821,
                    "customerBranchId": 79934581,
                    "materialId": 0,
                    "materialName": "",
                    "customerBuyerMaterialId": 115959041,
                    "customerBuyerMaterialName": "毛巾消毒车",
                    "customerBuyerBranchId": 61032891
                },
                {
                    "tenantId": 61803421,
                    "customerId": 61312821,
                    "customerBranchId": 79934581,
                    "materialId": 0,
                    "materialName": "",
                    "customerBuyerMaterialId": 115959011,
                    "customerBuyerMaterialName": "32高压锅圈",
                    "customerBuyerBranchId": 61032891
                }]
            },
    "message": null,
    "error": null
}

修改发货数量¶

修改发货数量

请求地址¶

/suppliers/distribution/quantity/update

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
details	List<obj>	非空	需要修改发货数量的明细
—deliveryDetailId	long	非空	交货明细单id
—salesDetailId	long	非空	销售订单明细id，如果deliveryDetailId传入了有效值，那么salesDetailId不生效
—distributionQuantitySecond	bigDecimal	非空	收货单位发货数量

请求示例¶

{
        "details": [
            {
            "deliveryDetailId":18847227,
            "distributionQuantitySecond":10
            }
        ]
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	boolean	非空	true成功
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
"code": 200,
"data": true,
"message": null,
"error": null
}

确认配货¶

确认配货

请求地址¶

/suppliers/distribution/confirm

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
salesDeliveryIds	List<long>	可空	交货主单id集合
salesDeliveryCodes	List<string>	可空	交货编号集合

请求示例¶

    {
    "salesDeliveryIds":[118865,118815],
    "salesDeliveryCodes":[]
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	boolean	非空	true成功
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

    {
    "code": 200,
    "data": true,
    "message": null,
    "error": null
}

推送报价¶

推送报价

请求地址¶

/suppliers/negotiate/sales/price/push

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
customerIds	List<Long>	非空	客户id集合，与customerTenantId取并集
customerTenantIds	List<Long>	非空	客户租户id集合，与customerIds取并集
customerBranchIds	List<Long>	非空	客户门店id集合，与customerBuyerBranchIds取并集
customerBuyerBranchIds	List<Long>	非空	客户餐厅门店id集合，与customerBranchIds取并集
fromDateStr	string	非空	定价开始时间，格式：yyyy-MM-dd（1本次定价时间必须要大于最后一次定价结束时间. 2定价周期必须要连贯，即本次定价开始时间=最后一次定价结束时间+1天）
toDateStr	string	非空	定价结束时间，格式：yyyy-MM-dd
details	List<obj>	非空	报价商品
—materialId	long	非空	供应商物料id，与buyerMaterialId互斥，建议全部只传materialId或者buyerMaterialId
—buyerMaterialId	long	非空	餐厅物料id，与materialId互斥，建议全部只传materialId或者buyerMaterialId
—unitId	int	非空	报价单位
—price	BigDecimal	非空	未税单价
—taxPrice	BigDecimal	非空	含税单价
—taxRate	BigDecimal	非空	税率

请求示例¶

    {
    "customerIds": [61591178],
    "customerTenantIds":[],
    "customerBranchIds":[90302927],
    "customerBuyerBranchIds":[],
    "fromDateStr":"2023-3-1",
    "toDateStr":"2023-3-31",
    "details":[
        {
            "materialId": 126255065,
            "unitId":43,
            "price": 11,
            "taxPrice": 11,
            "taxRate": 0
        },
        {
            "materialId": 122654944,
            "unitId":71,
            "price": 22,
            "taxPrice": 22,
            "taxRate": 0
        },
        {
            "materialId": 121654951,
            "unitId":422,
            "price": 33,
            "taxPrice": 33,
            "taxRate": 0
        }
    ]
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	List<ojb>	非空	成功的单据，根据客户id和客户租户id为维度返回其对应的定价单id
—customerId	Long	非空	客户id
—customerTenantId	Long	非空	客户租户id
—priceId	Long	非空	定价单id，需要保存下来，后续要用到
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

    {
    "code": 200,
    "data": [
        {
            "customerId": 61519178,
            "customerTenantId": 61201445,
            "priceId": 6637586
        }
    ],
    "message": null,
    "error": null
}

更新报价¶

更新报价

请求地址¶

/suppliers/negotiate/sales/price/update

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
priceId	Long	非空	定价单id
customerBranchIds	List<Long>	非空	客户门店id集合，与customerBuyerBranchIds取并集
customerBuyerBranchIds	List<Long>	非空	客户餐厅门店id集合，与customerBranchIds取并集
details	List<obj>	非空	报价商品
—materialId	long	非空	供应商物料id，与buyerMaterialId互斥，建议全部只传materialId或者buyerMaterialId
—buyerMaterialId	long	非空	餐厅物料id，与materialId互斥，建议全部只传materialId或者buyerMaterialId
—unitId	int	非空	报价单位
—price	BigDecimal	非空	未税单价
—taxPrice	BigDecimal	非空	含税单价
—taxRate	BigDecimal	非空	税率

请求示例¶

    {
    "priceId": 66375186,
    "customerTenantIds":[],
    "customerBranchIds":[90309327],
    "customerBuyerBranchIds":[],
    "details":[
        {
            "materialId": 126550165,
            "unitId":4,
            "price": 112,
            "taxPrice": 111,
            "taxRate": 0
        },
        {
            "materialId": 126549414,
            "unitId":7,
            "price": 221,
            "taxPrice": 222,
            "taxRate": 0
        },
        {
            "materialId": 126549351,
            "unitId":42,
            "price": 331,
            "taxPrice": 333,
            "taxRate": 0
        },
        {
            "materialId": 144213228,
            "unitId":42,
            "price": 441,
            "taxPrice": 44,
            "taxRate": 0
        }
    ]
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	boolean	非空	成功返回ture
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

    {
    "code": 200,
    "data": true,
    "message": null,
    "error": null
}

确认销售订单¶

供应商确认销售订单

请求地址¶

/suppliers/confirm/order

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
salesOrderId	Long	非空	供应商销售订单ID
purchaseOrderId	Long	可空	采购订单ID，传了此字段可以不传salesOrderId
autoConfirmDistribute	boolean	可空	是否自动确认配货,true自动确认配货(配送中心订单需要确认配货餐厅才可以收货)

请求示例¶

{
        "salesOrderId": 18847277
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	boolean	非空	true成功
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
"code": 200,
"data": true,
"message": null,
"error": null
}

确认退货单¶

供应商确认退货单

请求地址¶

/suppliers/confirm/sales/return

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
salesReturnId	Long	非空	供应商退货单ID

请求示例¶

{
        "salesReturnId": 16847277
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	boolean	非空	true成功
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
"code": 200,
"data": true,
"message": null,
"error": null
}

取消销售订单¶

供应商取消销售订单明细，如果所有明细全部取消则相当于整单取消

请求地址¶

/suppliers/cancel/sales/order

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
cancelSalesOrderDetailIds	List<Long>	非空	供应商销售订单明细ID集合

请求示例¶

{
        "cancelSalesOrderDetailIds": [16847274,16848275,17847276]
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	boolean	非空	true成功
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
"code": 200,
"data": true,
"message": null,
"error": null
}

取消退货单¶

供应商取消退货单明细，如果所有明细全部取消则相当于整单取消

请求地址¶

/suppliers/cancel/sales/return

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
cancelSalesReturnDetailIds	List<Long>	非空	供应商退货单明细ID集合

请求示例¶

{
        "cancelSalesReturnDetailIds": [18847274,21848275,15847276]
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	boolean	非空	true成功
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
"code": 200,
"data": true,
"message": null,
"error": null
}

部门(档口)开放接口¶

新增部门（档口）¶

请求地址¶

/departments

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

DepartmentParam对象¶
名称	类型	可空	描述
name	String	非空	拼音首字母
pinyin	String	可空	拼音首字母
erpCode	String	可空	erp编号
type	String	非空	部门类型1部门 2档口 3吧台 4前厅
parentId	long	可空	父级部门餐链系统id，与parentErpCode作用相同，优先使用parentId
parentErpCode	long	可空	父级部门ErpCode，与parentId作用相同，优先使用parentId

请求示例¶

{
        "name": "前厅",
        "pinyin": "qt",
        "erpCode": "c-1122301",
        "type": 1
}

ResponseJsonBody¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	IdKey	非空	返回的门店列表
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

IdKey

名称	类型	是否必须	描述
id	string	非空	主键ID

返回示例¶

{
    "code": 200,
    "data": {
        "id": "6090718"
    },
    "message": null,
    "error": null
}

获取所有部门（档口）¶

请求地址¶

/departments

HTTP方法¶

GET

URL参数¶

无

ResponseJsonBody¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	[Department]	非空	部门信息集合
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

部门（档口）基础信息¶

部门基础信息(Department)¶
名称	类型	可空	描述
id	long	非空	部门ID
name	stirng	非空	名称
pinyin	string	可空	部门简拼
typeId	string	非空	类型Id
typeName	string	非空	类型名称
erpCode	string	可空	ERP编号

返回示例¶

{
    "code": 200,
    "data": [{
        "id": 6000776,
        "name": "测试",
        "pinyin": "cf",
        "typeId": 2,
        "typeName": "档口",
        "erpCode": null
    }, {
        "id": 6043792,
        "name": "海鲜类",
        "pinyin": "hxl",
        "typeId": 2,
        "typeName": "档口",
        "erpCode": null
    }, {
        "id": 6043793,
        "name": "鸡鸭类",
        "pinyin": "jyl",
        "typeId": 2,
        "typeName": "档口",
        "erpCode": null
    }, {
        "id": 6043794,
        "name": "猪肉类",
        "pinyin": "zrl",
        "typeId": 2,
        "typeName": "档口",
        "erpCode": null
    }, {
        "id": 6043795,
        "name": "饮料类",
        "pinyin": "yll",
        "typeId": 2,
        "typeName": "档口",
        "erpCode": null
    }, {
        "id": 6043796,
        "name": "啤酒类",
        "pinyin": "pjl",
        "typeId": 2,
        "typeName": "档口",
        "erpCode": null
    }, {
        "id": 6054794,
        "name": "炒菜部",
        "pinyin": "ccb",
        "typeId": 2,
        "typeName": "档口",
        "erpCode": null
    }, {
        "id": 6056042,
        "name": "测试部门",
        "pinyin": "csbm",
        "typeId": 2,
        "typeName": "档口",
        "erpCode": null
    }, {
        "id": 6089366,
        "name": "餐纸",
        "pinyin": "cz",
        "typeId": 1,
        "typeName": "部门",
        "erpCode": null
    }, {
        "id": 6090718,
        "name": "物料1",
        "pinyin": null,
        "typeId": 1,
        "typeName": "部门",
        "erpCode": "test1"
    }],
    "message": null,
    "error": null
}

订单相关接口¶

创建采购订单¶

请求地址¶

/purchase/orders

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
supplierId	long	非空	供应商ID
deliveryTime	string	非空	交货时间
erpCode	string	可空	erp编号
orderDetails	[orderDetail]	非空	采购明细

OrderDetail对象

名称	类型	可空	描述
materialId	long	非空	物料ID
departmentId	long	非空	档口ID
quantity	double	非空	采购单位数量
erpCode	long	可空	订单erpcode

请求示例¶

    {
    "supplierId": 50046,  # 供应商id
    "erpCode": "cg-001",  # 订单erpcode
    "deliveryTime": "2018-07-20 13:59:59",  # 交货时间
    "orderDetails": [{
        "materialId": "5001605",  # 物料id
        "departmentId":123,  #档口ID
        "quantity": 12.2,  # 采购单位数量
        "erpCode": "123111123",  # 订单明细erpcode
    },{
        "materialId": "5001632",
        "departmentId":123,  #档口ID
        "quantity": 2.2,
        "secondQuantity": 1.2,
        "erpCode": "123111123",
    }]
}

ResponseJsonBody¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	IdKey	非空	返回新增订单的主键标识
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

IdKey

名称	类型	是否必须	描述
id	string	非空	主键ID

返回示例¶

{
    "code": 200,
    "data": {
        "id": "6090718"
    },
    "message": null,
    "error": null
}

采购订单推送（PUSH）¶

请求地址¶

请在餐链后台定义，定以后在餐链系统创建的采购订单会以HTTP方式推送到该地址

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
orderId	Long	非空	采购单ID
branchId	Long	非空	分支机构ID
branchErpCode	String	可空	接入方机构编码
branchName	String	可空	分支机构名称
branchErpCode	String	可空	接入方机构编码
supplierId	String	可空	分支机构名称
supplierErpCode	String	可空	接入方供应商编码
supplierTenantId	String	可空	供应商租户ID
supplierName	String	可空	供应商名称
deliveryTime	String	可空	交货时间
createdTime	String	可空	采购单创建日期
detail	[orderDetail]	非空	采购明细

OrderDetail对象

名称	类型	可空	描述
orderDetailId	Long	非空	采购订单明细ID
materialId	Long	非空	物料ID
materialErpCode	String	非空	接入方物料编码
materialName	String	可空	物料名称
departmentId	Long	可空	部门ID
departmentErpCode	String	可空	接入方部门编码
departmentName	String	可空	部门名称
unitId	Integer	可空	计量单位ID
unitName	String	可空	计量单位名称
secondUnitId	Integer	可空	第二单位ID
secondUnitName	String	可空	第二单位名称
quanity	BigDecimal	可空	数量
secondQuantity	double	可空	第二单位采购数量
price	BigDecimal	非空	价格

ResponseJsonBody¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	object	可空
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

修改账单¶

修改账单

请求地址¶

/bill/updatePrice

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
receiptId	string	非空	餐链收货单Id
billDetails	[BillDetailParam]	非空	账单详情

名称	类型	可空	描述
id	string	非空	餐链收货明细ID
price	double	非空	单价

请求示例¶

{
        "receiptId": 6715818,# 餐链收货单Id
        "billDetails": [{
                "id": "11468263",# 餐链收货明细ID
                "price": 4.1    # 单价
        }, {
                "id": "11468258",
                "price": 5.2
        }]
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	object	可空
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
        "code": 200,
        "data": true,
        "message": null,
        "error": null
}

快速创建采购订单¶

请求地址¶

/purchase/fastOrders

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
supplierErpCode	long	非空	供应商第三方编码
supplierName	long	非空	供应商名称
phone	long	非空	供应商电话
deliveryTime	string	非空	交货时间
orderErpCode	string	非空	订单erp编号
orderDetails	[orderDetails]	非空	采购明细

orderDetails对象

名称	类型	可空	描述
materialErpCode	string	非空	物料第三方编码
materialName	string	非空	物料名称
purchaseUnit	string	非空	采购单位
receiptUnit	string	非空	收货单位
baseUnit	string	非空	基本单位
purchaseRate	Bigdecimal	非空	基本单位与采购单位转换率
receiptRate	Bigdecimal	非空	基本单位与收货单位转换率
purchaseQuantity	double	非空	下单总量
departmentErpCode	string	非空	采购部门第三方编码
departmentName	string	非空	采购部门名称
orderDetailerpCode	string	非空	订单明细第三方编码

请求示例¶

{
    "supplierErpCode": 600002,
    "supplierName": "开放平台供应商",
    "phone": "13200007500",
    "orderErpCode": "6006000",
    "deliveryTime": "2018-12-17 20:59:59",
    "orderDetails": [{
        "materialErpCode": "6006005",
        "materialName": "自动003",
        "purchaseUnit": "斤",
        "receiptUnit": "斤",
        "baseUnit": "斤",
        "purchaseRate": "1",
        "receiptRate": "1",
        "purchaseQuantity": "5",
        "departmentErpCode": "10001",
        "departmentName": "自动档口01",
        "orderDetailerpCode": "7001"
    }, {
        "materialErpCode": "6006006",
        "materialName": "自动004",
        "purchaseUnit": "箱",
        "receiptUnit": "斤",
        "baseUnit": "桶",
        "purchaseRate": "1",
        "receiptRate": "1",
        "purchaseQuantity": "12",
        "departmentErpCode": "10002",
        "departmentName": "自动档口107",
        "orderDetailerpCode": "7002"
    }]
}

ResponseJsonBody¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	IdKey	非空	返回新增订单的主键标识
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

IdKey

名称	类型	是否必须	描述
id	string	非空	主键ID

返回示例¶

{
    "code": 200,
    "data": {
        "id": "6090718"
    },
    "message": null,
    "error": null
}

确认订单¶

确认订单:

请求地址¶

/suppliers/confirm/order

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
salesOrderId	Long	可空	餐链销售订单id，与餐链采购订单id不能同时为空。优先使用销售订单id
purchaseOrderId	Long	可空	餐链采购订单id，与餐链销售订单id不能同时为空。优先使用销售订单id

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	null	空
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
"code": 200,
"data": true,
"message": null,
"error": null
}

物料开放接口¶

根据ID查询物料信息¶

根据ID查询物料信息

请求地址¶

/materials/{materialId}

HTTP方法¶

GET

URL参数¶

无

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	Material	空	物料基础信息
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

物料基础信息¶

物料基础信息(Matreial)¶
名称	类型	可空	描述
materialId	long	非空	物料ID
name	stirng	非空	物料简名
fullName	string	非空	物料全名
pinyin	string	可空	物料简拼
fullPinyin	string	可空	物料全拼
code	string	可空	物料编码
statusId	Integer	可空	物料状态id
statusName	string	可空	物料状态名称
barcode	string	可空	物料条形码
categoryId	int	可空	所属物料类型,1:食材,2:耗品
classId	long	非空	物料所属类别
purchaseUnitId	int	非空	采购单位ID
purchaseUnitName	string	非空	采购单位名称
inventoryUnitId	int	非空	库存单位ID
inventoryUnitName	string	非空	库存单位名称
receiptUnitId	int	非空	收货结算单位ID
receiptUnitName	string	非空	收货结算单位名称
salesUnitId	int	非空	耗用单位ID
salesUnitName	string	非空	耗用单位名称
baseUnitId	int	非空	基本单位ID
baseUnitName	string	非空	基本单位名称
purchaseRate	string	非空	申购单位转基本单位的比率
salesRate	string	非空	耗用单位转基本单位的比率
receiptRate	string	非空	收货单位转基本单位的比率
inventoryRate	string	非空	库存单位转基本单位的比率
acceptanceIndexs	[AcceptanceIndex]	可空	物料验收标准

验收标准(AcceptanceIndex)¶
名称	类型	可空	描述
name	string	非空	验收标准
description	string	可空	验收标准描述

返回示例¶

{
    "code": 200,
    "data": {
        "materialId": 5001557,
        "name": "茄子",
        "fullName": "茄子",
        "pinyin": "QZ",
        "fullPinyin": "QIEZI",
        "code": "1",
        "statusId": "1",
        "statusName": "正常",
        "barcode": null,
        "categoryId": 1,
        "classId": 500114,
        "purchaseUnitId": 42,
        "purchaseUnitName": "斤",
        "inventoryUnitId": 42,
        "inventoryUnitName": "斤",
        "receiptUnitId": 42,
        "receiptUnitName": "斤",
        "salesUnitId": 45,
        "salesUnitName": "克",
        "baseUnitId": 42,
        "baseUnitName": "斤",
        "purchaseRate": 1.0000,
        "salesRate": 500.0000,
        "receiptRate": 1.0000,
        "inventoryRate": 1.0000,
        "acceptanceIndexs": [{
            "id": 1035,
            "name": "手感坚实质嫩，不松软",
            "description": "-",
            "ordinal": 0
        }, {
            "id": 1036,
            "name": "大小均匀",
            "description": "-",
            "ordinal": 0
        }, {
            "id": 1037,
            "name": "略显润泽",
            "description": "-",
            "ordinal": 0
        }]
    },
    "message": null,
    "error": null
}

根据erp_code查询物料信息¶

根据erp物料编号查询物料信息

请求地址¶

/materials/erpcode/{materialErpCode}

HTTP方法¶

GET

URL参数¶

无

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	Material	空	物料基础信息
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

Material: material_table

返回示例¶

{
    "code": 200,
    "data": {
        "materialId": 5001557,
        "name": "茄子",
        "fullName": "茄子",
        "pinyin": "QZ",
        "fullPinyin": "QIEZI",
        "code": "1",
        "barcode": null,
        "categoryId": 1,
        "classId": 500114,
        "purchaseUnitId": 42,
        "purchaseUnitName": "斤",
        "inventoryUnitId": 42,
        "inventoryUnitName": "斤",
        "receiptUnitId": 42,
        "receiptUnitName": "斤",
        "salesUnitId": 45,
        "salesUnitName": "克",
        "baseUnitId": 42,
        "baseUnitName": "斤",
        "purchaseRate": 1.0000,
        "salesRate": 500.0000,
        "receiptRate": 1.0000,
        "inventoryRate": 1.0000,
        "acceptanceIndexs": [{
            "id": 1035,
            "name": "手感坚实质嫩，不松软",
            "description": "-",
            "ordinal": 0
        }, {
            "id": 1036,
            "name": "大小均匀",
            "description": "-",
            "ordinal": 0
        }, {
            "id": 1037,
            "name": "略显润泽",
            "description": "-",
            "ordinal": 0
        }]
    },
    "message": null,
    "error": null
}

添加物料¶

添加物料

请求地址¶

/materials

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
name	string	非空	物料名称
fullName	string	非空	物料全称
pinyin	string	非空	物料名称拼音
fullPinyin	string	非空	物料全称拼音
code	string	可空	物料编码
barcode	string	可空	条形码
categoryId	int	非空	物料类型,1:食材,2:耗品
classId	long	非空	物料类别
erpCode	string	可空	ERP物料编号
purchaseUnit	string	非空	申购单位
receiptUnit	string	非空	收货单位
inventoryUnit	string	非空	库存单位
salesUnit	string	非空	耗用单位
baseUnit	string	非空	基本单位
purchaseRate	double	非空	申购单位转基本单位的比率
receiptRate	double	非空	收货单位转基本单位的比率
inventoryRate	double	非空	库存单位转基本单位的比率
salesRate	double	非空	耗用单位转基本单位的比率
spec	String	可空	物料规格

注解

基本单位应为最小单位。

purchaseRate存的是申购单位转基本单位的比率，比如1件=12瓶，件为申购单位,瓶为基本单位，则12为申购单位转基本单位的比率(purchaseRate=12)。

receiptRate存的是收货单位转基本单位的比率，比如1箱=24瓶，箱为收货单位，瓶为基本单位，则24为收货单位转基本单位的比率(receiptRate=24)。

因此：当申购数量为2件，换算成收货数量则为1箱 = (2*12) / (24) = (申购数量 * 申购单位转基本单位的比率) / (收货单位转基本单位的比率)

请求示例¶

{
    "name": "党参",  # 物料简称
    "fullName": "党参",  # 物料名称
    "pinyin": "ds",  # 简拼
    "fullPinyin": "dangsheng",  # 全拼
    "code": "ds001",  # 编码
    "barcode": "0002",  # 条码
    "categoryId": 1,  # 1是原材料 2是易耗品
    "classId": 0,  # 系统分类
    "erpCode": "10002",  # 第三方id
    "purchaseUnit": "两",  # 申购单位
    "receiptUnit": "斤",  # 收货单位
    "inventoryUnit": "斤",  # 库存单位
    "salesUnit": "克",  # 耗用单位
    "baseUnit": "克",  # 基本单痊
    "purchaseRate": 50,  # 申购单位转基本单位的比率
    "receiptRate": 500,  # 收货单位转基本单位的比率
    "inventoryRate": 500,  # 库存单位转基本单位的比率
    "salesRate": 1,  # 耗用单位转基本单位的比率
    "spec": "一包十斤"  # 规格
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	IdKey	非空	返回新增的物料主键标识
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

IdKey

名称	类型	是否必须	描述
id	string	非空	主键ID

返回示例¶

{
"code": 200,
"data": {
        "id": "6000639"
},
"message": null,
"error": null
}

更新物料¶

更新物料

请求地址¶

/materials/{materialId}

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
name	string	非空	物料名称
fullName	string	非空	物料全称
pinyin	string	非空	物料名称拼音
fullPinyin	string	非空	物料全称拼音
code	string	可空	物料编码
barcode	string	可空	条形码
categoryId	int	非空	物料类型,1:食材,2:耗品
classId	long	非空	物料类别
erpCode	string	可空	ERP物料编号
purchaseUnit	string	非空	申购单位
receiptUnit	string	非空	收货单位
inventoryUnit	string	非空	库存单位
salesUnit	string	非空	耗用单位
baseUnit	string	非空	基本单位
purchaseRate	string	非空	申购单位转基本单位的比率
receiptRate	string	非空	收货单位转基本单位的比率
inventoryRate	string	非空	库存单位转基本单位的比率
salesRate	string	非空	耗用单位转基本单位的比率
spec	String	可空	物料规格

请求示例¶

{
    "name": "党参",  # 物料简称
    "fullName": "党参",  # 物料名称
    "pinyin": "ds",  # 简拼
    "fullPinyin": "dangsheng",  # 全拼
    "code": "ds001",  # 编码
    "barcode": "0002",  # 条码
    "categoryId": 1,  # 1是原材料 2是易耗品
    "classId": 0,  # 系统分类
    "erpCode": "10002",  # 第三方id
    "purchaseUnit": "两",  # 申购单位
    "receiptUnit": "斤",  # 收货单位
    "inventoryUnit": "斤",  # 库存单位
    "salesUnit": "克",  # 耗用单位
    "baseUnit": "克",  # 基本单痊
    "purchaseRate": 50,  # 申购单位转基本单位的比率
    "receiptRate": 500,  # 收货单位转基本单位的比率
    "inventoryRate": 500,  # 库存单位转基本单位的比率
    "salesRate": 1,  # 耗用单位转基本单位的比率
    "spec": "一包十斤"  # 规格
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	object	可空
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
    "code": 200,
    "data": true,
    "message": null,
    "error": null
}

更新物料ERP_CODE¶

更新物料ERP_CODE

请求地址¶

/materials/erpCode/update/{materialId}

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
erpCode	string	非空	ERP物料编号

请求示例¶

{
    "erpCode": "10002",  # 第三方id
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	object	可空
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
    "code": 200,
    "data": true,
    "message": null,
    "error": null
}

移除物料¶

去掉指定物料

请求地址¶

/materials/{materialId}

HTTP方法¶

DELETE

URL参数¶

无

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	object	可空
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
"code": 200,
"data": true,
"message": null,
"error": null
}

查询所有物料(分页查询)¶

分页查询所有物料

请求地址¶

/materials

HTTP方法¶

GET

URL参数¶

参数名	类型	是否必须	描述
pageIndex	int	必须	第几页，默认是第一页开始
pageSize	int	必须	每页数据条数，默认不能超过20条每页

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	Page<Material>	空	物料信息分页数据
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

Page<Material>

名称	类型	可空	描述
pageNum	int	非空	当前页数
datas	[Material]	可空	物料信息集合
pageSize	string	非空	分页每页条数
total	string	非空	数据总条数
pages	int	非空	分页总页数

名称	类型	描述
id	long	物料ID
tenantId	long	租户id
code	long	物料编号
name	string	物料别名
fullName	string	物料名称, 申购时使用
pinyin	string	拼音
categoryId	int	物料种类 1:原村料 2:低值易耗
classId	long	物料分类id
purchaseUnitId	long	计量单位ID（订单）
purchaseUnitName	string	计量单位名称（订单）
inventoryUnitId	long	计量单位ID（库存）
inventoryUnitName	string	计量单位名称（库存）
salesUnitId	long	计量单位ID（耗用）
salesUnitName	string	计量单位名称（耗用）
receiptDeliveryUnitId	long	计量单位ID（收货结算）
receiptDeliveryUnitName	string	计量单位名称（收货结算）
statusId	int	状态 (0:禁用 1:启用 2:删除)
tenantErpCode	int	租户ErpCode
materialErpCode	int	物料ErpCode
erpCode	int	当前门店物料ErpCode
materialUnits	[Rate对象]	物料单位转换关系

Rate对象¶

id	long	Id
unitId	long	计量单位ID
unitName	string	计量单位名称
rate	double	转换值此单位到收货单位的转换率
isFixedExchange	bool	是否绝对转换
isBaseExchange	bool	是否到库存单位转换

返回示例¶

{
       "code": 200,
       "data": {
               "pageNum": 1,
               "pageSize": 2,
               "total": 1721,
               "pages": 861,
               "datas": [{
                       "id": 5001561,
                       "tenantId": 50135,
                       "code": "5",
                       "name": "1",
                       "fullName": "黄瓜",
                       "pinyin": "HG",
                       "categoryId": 1,
                       "classId": 500114,
                       "purchaseUnitId": 42,
                       "purchaseUnitName": "斤",
                       "inventoryUnitId": 42,
                       "inventoryUnitName": "斤",
                       "salesUnitId": 45,
                       "salesUnitName": "克",
                       "receiptDeliveryUnitId": 42,
                       "receiptDeliveryUnitName": "斤",
                       "statusId": 1,
                       "tenantErpCode": "400001",
                       "materialErpCode": "100005",
                       "erpCode": "100005",
                       "materialUnits": [{
                               "id": 6914028,
                               "unitId": 42,
                               "unitName": "斤",
                               "rate": 1.0,
                               "isBaseExchange": 1.0,
                               "fixedExchange": true
                       }, {
                               "id": 6914029,
                               "unitId": 42,
                               "unitName": "斤",
                               "rate": 1.0,
                               "isBaseExchange": 1.0,
                               "fixedExchange": true
                       }, {
                               "id": 6914030,
                               "unitId": 45,
                               "unitName": "克",
                               "rate": 1.0,
                               "isBaseExchange": 0.0,
                               "fixedExchange": true
                       }, {
                               "id": 7265712,
                               "unitId": 42,
                               "unitName": "斤",
                               "rate": 1.0,
                               "isBaseExchange": 1.0,
                               "fixedExchange": true
                       }]
               }, {
                       "id": 5001563,
                       "tenantId": 50135,
                       "code": "7",
                       "name": "1",
                       "fullName": "老南瓜",
                       "pinyin": "LNG",
                       "categoryId": 1,
                       "classId": 500114,
                       "purchaseUnitId": 9,
                       "purchaseUnitName": "个",
                       "inventoryUnitId": 42,
                       "inventoryUnitName": "斤",
                       "salesUnitId": 42,
                       "salesUnitName": "斤",
                       "receiptDeliveryUnitId": 42,
                       "receiptDeliveryUnitName": "斤",
                       "statusId": 1,
                       "tenantErpCode": "400001",
                       "materialErpCode": "",
                       "erpCode": "",
                       "materialUnits": [{
                               "id": 6032527,
                               "unitId": 9,
                               "unitName": "个",
                               "rate": 30.0,
                               "isBaseExchange": 1.0,
                               "fixedExchange": true
                       }, {
                               "id": 6032528,
                               "unitId": 42,
                               "unitName": "斤",
                               "rate": 1.0,
                               "isBaseExchange": 1.0,
                               "fixedExchange": true
                       }, {
                               "id": 6032529,
                               "unitId": 42,
                               "unitName": "斤",
                               "rate": 1.0,
                               "isBaseExchange": 0.0,
                               "fixedExchange": true
                       }, {
                               "id": 7265714,
                               "unitId": 42,
                               "unitName": "斤",
                               "rate": 1.0,
                               "isBaseExchange": 1.0,
                               "fixedExchange": true
                       }]
               }]
       },
       "message": null,
       "error": null
       }

新增物料分类¶

新增物料分类

请求地址¶

/material/classes

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

MaterialClass对象¶
名称	类型	是否必须	描述
classId	long	非空	主键ID
name	string:50	非空	分类名称
parentId	long	可空	上级分类ID
pinyin	string:20	可空	分类名称拼音
categoryId	int	非空	分类所属物料类型,1:食材,2:耗品
isPurchase	int	非空	是否可采购1:允许 0:不允许
tenantId	long	非空	所属商户ID
children	[MaterialClass]	可空	下级分类

请求示例¶

{
    "name": "分区啤酒类6",  # 物料分类名称
    "pinyin": "1231111",  # 分类拼音
    "parentId": 456,  # 分类父id 默认0
    "parentErpCode":1, # 分类父编码
    "categoryId": 1,  # 科目 1原材料,2易耗品
    "isPurchase": 1,  # 是否可采购 1 可采购
    "erpCode": "123",  # 物料分类erpCode
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	IdKey	非空	返回新增的供应商的主键标识
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

IdKey

名称	类型	是否必须	描述
id	string	非空	主键ID

返回示例¶

{
"code": 200,
"data": {
        "id": "6001089"
},
"message": null,
"error": null
}

查询物料分类¶

查询物料分类

请求地址¶

/material/classes

HTTP方法¶

GET

URL参数¶

参数名	类型	是否必须	描述
pageIndex	int	必须	第几页，默认是第一页开始
pageSize	int	必须	每页数据条数，每页默认不能超过20条

Response Json Body

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	MaterialClass	非空	返回物料的分类目录
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

MaterialClass对象¶

名称	类型	描述
id	long	物料分类ID
tenantId	long	租户id
parentId	long	父级分类id
name	string	分类名称
categoryId	int	物料种类id
ordinal	int	排序号
statusId	int	状态 (0:禁用 1:启用 2:已删除)
leaf	bool	是否叶子节点
purchase	bool	是否可申购 (true:是 false:否)
tenantErpCode	string	租户erpcode

返回示例¶

{
    "code": 200,
    "data": {
        "pageNum": 1,
        "pageSize": 100,
        "total": 27,
        "pages": 1,
        "datas": [{
            "id": 6208163,
            "tenantId": 6090677,
            "parentId": 0,
            "name": "鲜货类",
            "categoryId": "1",
            "ordinal": "100",
            "statusId": "1",
            "tenantErpCode": "NULL",
            "leaf": true,
            "purchase": true
        }, {
            "id": 6208164,
            "tenantId": 6090677,
            "parentId": 6208163,
            "name": "牛肉",
            "categoryId": "1",
            "ordinal": "100",
            "statusId": "1",
            "tenantErpCode": "NULL",
            "leaf": true,
            "purchase": true
        }]
    },
    "message": null,
    "error": null
}

获取门店下已删除物料的集合¶

获取门店下已删除物料的集合

请求地址¶

/materials/delete/list

HTTP方法¶

GET

URL参数¶

无

物料基础信息¶

物料基础信息(Matreial)¶
名称	类型	可空	描述
materialId	long	非空	物料ID
name	stirng	非空	物料简名
fullName	string	非空	物料全名
pinyin	string	可空	物料简拼
fullPinyin	string	可空	物料全拼
code	string	可空	物料编码
statusId	Integer	可空	物料状态id
statusName	string	可空	物料状态名称
barcode	string	可空	物料条形码
categoryId	int	可空	所属物料类型,1:食材,2:耗品
classId	long	非空	物料所属类别
purchaseUnitId	int	非空	采购单位ID
purchaseUnitName	string	非空	采购单位名称
inventoryUnitId	int	非空	库存单位ID
inventoryUnitName	string	非空	库存单位名称
receiptUnitId	int	非空	收货结算单位ID
receiptUnitName	string	非空	收货结算单位名称
salesUnitId	int	非空	耗用单位ID
salesUnitName	string	非空	耗用单位名称
baseUnitId	int	非空	基本单位ID
baseUnitName	string	非空	基本单位名称
purchaseRate	string	非空	申购单位转基本单位的比率
salesRate	string	非空	耗用单位转基本单位的比率
receiptRate	string	非空	收货单位转基本单位的比率
inventoryRate	string	非空	库存单位转基本单位的比率
acceptanceIndexs	[AcceptanceIndex]	可空	物料验收标准

验收标准(AcceptanceIndex)¶
名称	类型	可空	描述
name	string	非空	验收标准
description	string	可空	验收标准描述

返回示例¶

{
    "code": 200,
    "data": [{
        "materialId": 5001557,
        "name": "茄子",
        "fullName": "茄子",
        "pinyin": "QZ",
        "fullPinyin": "QIEZI",
        "code": "1",
        "statusId": "1",
        "statusName": "正常",
        "barcode": null,
        "categoryId": 1,
        "classId": 500114,
        "purchaseUnitId": 42,
        "purchaseUnitName": "斤",
        "inventoryUnitId": 42,
        "inventoryUnitName": "斤",
        "receiptUnitId": 42,
        "receiptUnitName": "斤",
        "salesUnitId": 45,
        "salesUnitName": "克",
        "baseUnitId": 42,
        "baseUnitName": "斤",
        "purchaseRate": 1.0000,
        "salesRate": 500.0000,
        "receiptRate": 1.0000,
        "inventoryRate": 1.0000,
        "acceptanceIndexs": [{
            "id": 1035,
            "name": "手感坚实质嫩，不松软",
            "description": "-",
            "ordinal": 0
        }, {
            "id": 1036,
            "name": "大小均匀",
            "description": "-",
            "ordinal": 0
        }, {
            "id": 1037,
            "name": "略显润泽",
            "description": "-",
            "ordinal": 0
        }]
    }],
    "message": null,
    "error": null
}

恢复指定商品¶

恢复指定商品

请求地址¶

/materials/recycle/recover

HTTP方法¶

POST

URL参数¶

无

Response Json Body¶

名称	类型	可空	描述
materialIds	array[long]	非空	需要恢复的已删除状态的物料id集合

请求示例¶

[1,2,3]

返回示例¶

{
    "code": 200,
    "data": true,
    "message": null,
    "error": null
}

单位开放接口¶

查询物料单位¶

查询物料单位

请求地址¶

/units

HTTP方法¶

GET

URL参数¶

参数名	类型	是否必须	描述
pageIndex	int	必须	第几页，默认是第一页开始
pagesize	int	必须	每页数据条数，默认不能超过20条每页

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	Page<Material>	可空	物料信息分页数据
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

Page<Material>

名称	类型	可空	描述
pageNum	int	非空	当前页数
datas	[物料基础信息]	可空	物料信息集合
pageSize	string	非空	分页每页条数
total	string	非空	数据总条数
pages	int	非空	分页总页数

物料基础信息¶

物料基础信息(Units)¶
名称	类型	可空	描述
unitId	long	非空	单位ID
name	stirng	非空	单位名称

返回示例¶

{
        "code": 200,
        "data": {
                "pageNum": 1,
                "pageSize": 2,
                "total": 112,
                "pages": 56,
                "datas": [{
                        "unitId": 1,    #单位ID
                        "name": "只"     #单位名称
                }, {
                        "unitId": 2,
                        "name": "罐"
                }]
        },
        "message": null,
        "error": null
}

添加物料单位¶

添加物料单位

请求地址¶

/units

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
name	string	非空	单位名称

请求示例¶

{
    "name": "斤"  # 物料名称
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	IdKey	非空	返回新增的物料主键标识
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

IdKey

名称	类型	是否必须	描述
id	string	非空	主键ID

返回示例¶

{
"code": 200,
"data": {
        "id": "6000639"
},
"message": null,
"error": null
}

库存相关接口¶

销售出库¶

请求地址¶

/stock/out

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	可空	描述
departmentId	long	非空	部门ID
departmentErpCode	string	可空	对接方部门ID
createdTime	string	可空	erp编号
erpCode	string	可空	对接方出库单ID
detail	[OpenStockDetail]	非空	采购明细

OpenStockDetail对象

名称	类型	可空	描述
materialId	long	非空	物料ID
materialErpCode	long	可空	对接方物料ID
quantity	double	非空	数量
unit	long	非空	计量单位
amount	long	非空	小计

ResponseJsonBody¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	string	空
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

返回示例¶

{
    "code": 0,
    "data": true,
    "message": null,
    "error": null
}

人员开放接口¶

新增员工¶

新增员工

请求地址¶

/employees

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

add_employee对象¶
名称	类型	是否必须	描述
departmentId	long	非空	部门ID
name	string:50	非空	员工名称
userCode	string	非空	员工登录账号(必须为手机号码)
userPassword	string	非空	密码
sex	string	可空	性别男 or 女
mobile	string	非空	电话
idCard	string	可空	身份证号码
birthDate	string	可空	生日 yyyy-MM-dd
erpCode	string	可空	第三方系统员工编号

请求示例¶

{
        "departmentId": 6090718,
        "name": "王五",
        "userCode": "qianlei3",
        "userPassword": "11",
        "sex": "女",
        "mobile": "13874813391",
        "idCard": "4123412",
        "birthDate": "1988-08-08",
        "erpCode": "erpCode"
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	IdKey	非空	返回新增的员工主键标识
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

IdKey

名称	类型	是否必须	描述
id	string	非空	主键ID

返回示例¶

{
"code": 200,
"data": {
        "id": "6001089"
},
"message": null,
"error": null
}

修改员工信息¶

修改员工信息

请求地址¶

/employees/{id}

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

add_employee对象¶
名称	类型	是否必须	描述
departmentId	long	非空	部门ID
name	string:50	非空	员工名称
userPassword	string	非空	密码
sex	string	可空	性别男 or 女
mobile	string	非空	电话
idCard	string	可空	身份证号码
birthDate	string	可空	生日 yyyy-mm-dd
erpCode	string	可空	第三方系统员工编号

请求示例¶

{
        "departmentId": 6090718,
        "name": "王五",
        "userPassword": "11",
        "sex": "女",
        "mobile": "13874813392",
        "idCard": "4123412",
        "birthDate": "1988-08-08",
        "erpCode": "erpCode"
}

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	IdKey	非空	返回新增的员工主键标识
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

IdKey

名称	类型	是否必须	描述
id	string	非空	主键ID

返回示例¶

{
"code": 200,
"data": {
        "id": "6001089"
},
"message": null,
"error": null
}

查询所有员工¶

查询所有员工

请求地址¶

/employees

HTTP方法¶

GET

URL参数¶

参数名	类型	是否必须	描述
page	int	可空	第几页，默认是第一页开始
pagesize	int	可空	每页数据条数，每页默认不能超过20条

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
data	Page<Employee>	可空	员工基础信息集合
message	string	可空	描述业务非正常处理原因
error	string	可空	描述业务非正常处理的错误码

Page<Employee>

名称	类型	可空	描述
pageNum	int	非空	当前页数
datas	[Employee]	可空	员工信息集合
pageSize	string	非空	分页每页条数
total	string	非空	数据总条数
pages	int	非空	分页总页数

员工基础信息¶

员工基础信息(Employee)¶
名称	类型	可空	描述
id	long	非空	员工ID
tenantId	Long	非空	员工租户ID
branchId	Long	非空	员工门店ID
departmentId	Long	非空	员工部门档口ID
name	string	可空	员工名称
userCode	string	可空	员工登录用户名
statusId	Integer	非空	状态ID
statusText	string	非空	状态说明
sex	string	可空	性别
mobile	string	可空	手机号码
userId	long	非空	用户ID
idCard	string	可空	证件号码
birthDate	string	可空	生日
modifierId	Long	可空	修改人
modifiedDate	String	可空	修改时间
erpCode	String	可空	第三方员工编号

返回示例¶

{
        "code": 200,
        "data": {
                "pageNum": 1,
                "pageSize": 2,
                "total": 37,
                "pages": 19,
                "datas": [{
                        "id": 6000914,
                        "tenantId": 50135,
                        "branchId": 6000070,
                        "departmentId": 0,
                        "name": "厨师长",
                        "userCode": "cz1d001",
                        "statusId": 1,
                        "statusText": "启用",
                        "sex": null,
                        "mobile": "15802601451",
                        "idCard": null,
                        "birthDate": null,
                        "modifierId": 735,
                        "modifiedDate": "2018-01-17 16:38:01",
                        "erpCode": null
                }, {
                        "id": 6000915,
                        "tenantId": 50135,
                        "branchId": 6000070,
                        "departmentId": 6000776,
                        "name": "厨师长",
                        "userCode": "13700000001",
                        "statusId": 1,
                        "statusText": "启用",
                        "sex": "男",
                        "mobile": "13700000001",
                        "idCard": null,
                        "birthDate": null,
                        "modifierId": 735,
                        "modifiedDate": "2018-01-17 16:37:41",
                        "erpCode": null
                }]
        },
        "message": null,
        "error": null
}

菜品开放接口¶

批量同步菜品¶

批量同步菜品（一次最多支持50）

请求地址¶

/variety/dishes/batch/sync

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	是否必须	描述
erpCode	String	非空	第三方erpCode
dishesId	Long	可空	餐链菜品ID，如果不为空并且大于零则进行修改操作，反之新增
dishesName	String	非空	菜品名称（租户下所有科目的商品不能重名。且长度不能超过30个字符）
className	String	非空	菜品所属分类名称（不能与租户下现有非菜品科目的商品分类重名。且长度不能超过30个字符）
parentClassName	String	可空	菜品所属分类的父级分类名字（不能与租户下现有非菜品科目的商品分类重名。且长度不能超过30个字符）
unitName	String	非空	菜品单位名称（长度不能超过30个字符）
dishPic	List<String>	可空	菜品图片集合（最多支持5张图片）
effectType	int	非空	菜品类型（1通用、2临时）,如果是临时则需要指定下面的effectBeginTime、effectEndTime
effectBeginTime	String	可空	菜品有效开始时间（如果effectType=2，则此处必填）
effectEndTime	String	可空	菜品有效截止时间（如果effectType=2，则此处必填）
cookingMethod	int	非空	做法（1炒、2煎、3蒸、4炖、5煮、6烤、7焖）
taste	List<Long>	非空	口味（1鲜嫩、2香辣、3麻辣、4酸甜、5不辣、6微辣、7中辣、8重辣）
sellPrice	BigDecimal	可空	销售价格（默认为零）
takeOutPrice	BigDecimal	可空	外卖价（默认为零）
membershipPrice	BigDecimal	可空	会员价（默认为零）
standardCost	BigDecimal	可空	标准成本（默认为零）
grossMarginMax	BigDecimal	可空	毛利率上限（必须大于毛利率下限）
grossMarginMin	BigDecimal	可空	毛利率下限（必须小于毛利率上限）
returnInStock	int	非空	退回是否入库（1退回入库、2退回不入库）
note	String	可空	备注（长度不能超过50个字符）
statusId	int	非空	状态（1上架2下架）
reserve	int	非空	是否堂食 1是 0不是
takeout	int	非空	是否外卖 1是 0不是

请求示例¶

[{
"erpCode":"erpCode1",
"dishesName":"这是一个测试菜品",
"className":"这是一个测试分类",
"unitName":"斤",
"dishPic":["http://testpicqiniucdn.mealcome.cn/msci_861504034253606_1576233149979.jpg","http://testpicqiniucdn.mealcome.cn/msci_861504032160192_1576057055955.jpg"],
"effectType":"2",
"effectBeginTime":"2019-9-1 00:00:00",
"effectEndTime":"2019-9-30 23:59:59",
"cookingMethod":"2",
"taste":[1,2,3],
"sellPrice":"2",
"takeOutPrice":"10",
"membershipPrice":"20",
"standardCost":"30",
"grossMarginMax":"50",
"grossMarginMin":"40",
"returnInStock":"1",
"note":"测试新增",
"statusId":"1",
"reserve":"1",
"takeout":"1"
},{
    "erpCode":"erpCode2",
    "dishesId":"119299367",
    "dishesName":"这是一个测试菜品1",
    "className":"这是一个测试分类",
    "unitName":"斤",
    "dishPic":[],
    "effectType":"1",
    "effectBeginTime":"",
    "effectEndTime":"",
    "cookingMethod":"1",
    "taste":[2],
    "sellPrice":"1",
    "takeOutPrice":"",
    "membershipPrice":"",
    "standardCost":"",
    "grossMarginMax":"",
    "grossMarginMin":"",
    "returnInStock":"1",
    "note":"测试修改",
    "statusId":"2",
    "reserve":"0",
    "takeout":"1"
}]

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
message	String	可空	描述业务非正常处理原因
error	String	可空	描述业务非正常处理的错误码
data	SyncInfo对象	可空	返回值具体信息

SyncInfo对象¶

名称	类型	可空	描述
successList	SyncSuccess对象	非空	绑定成功的集合
failList	SyncFail对象	非空	绑定失败的集合

SyncSuccess对象¶

名称	类型	可空	描述
erpCode	String	非空	参数传递过来的erpCode
dishesId	Long	非空	我方绑定的菜品ID
note	String	非空	备注

SyncFail对象¶

名称	类型	可空	描述
erpCode	String	非空	参数传递过来的erpCode
error	String	非空	绑定失败的原因

返回示例¶

    {
    "code": 200,
    "data": {
        "successList": [
            {
                "erpCode": "erpCode1",
                "dishesId": 119299378,
                "note": "新增成功"
            },
            {
                "erpCode": "erpCode2",
                "dishesId": 119299367,
                "note": "修改成功"
            }
        ],
        "failList": []
    },
    "message": null,
    "error": null
}

注解

我方商品、商品分类均有所属科目（原材料、易耗品、半成品、菜品），此接口只支持操作菜品科目的商品、商品分类。租户下所有科目的商品、商品分类均不能重名

批量同步菜品销售订单¶

批量同步菜品销售订单（一次最多支持50）

请求地址¶

/variety/dishes/order/batch/sync

HTTP方法¶

POST

URL参数¶

无

Request Json Body¶

名称	类型	是否必须	描述
erpType	int	非空	第三方类型，由餐链分配，对接前需要联系餐链工作人员获取
erpCode	String	非空	第三方erpCode
businessTime	Date	可空	单据产生时间(格式：yyyy-MM-dd HH:mm:ss)，默认为当前时间
note	String	可空	备注（备注长度不能大于150）
detailList	SyncInfo对象	非空	销售详情

SyncInfo对象¶

名称	类型	是否必须	描述
erpCode	String	非空	第三方明细erpCode
departmentId	Long	可空	部门id
dishesId	Long	非空	第三方菜品ID
dishesName	String	可空	菜品名称
salesQuantity	BigDecimal	可空（默认为零）	销售数量
price	BigDecimal	可空（默认为零）	单价
amount	BigDecimal	可空（默认为零）	金额
discountAmount	BigDecimal	可空（默认为零）	折后金额
returnQuantity	BigDecimal	可空（默认为零）	退回数量
returnAmount	BigDecimal	可空（默认为零）	退回金额
returnInstockQuantity	BigDecimal	可空（默认等于returnQuantity）	退回入库数量
returnInstockAmount	BigDecimal	可空（默认等于returnAmount）	退回入库金额
takeawayTag	int	可空（默认为1）	下单标签 1堂食 2外卖 3电商 4自提
table	string	可空	桌号

请求示例¶

    [{
    "erpType":10001,
    "erpCode":"erpCode332",
    "note":"notenotenote",
    "detailList":[{
        "erpCode":"detailErpCode1",
        "departmentId":0,
        "dishesId":"119299337",
        "dishesName":"这是一个测试菜品",
        "salesQuantity":"1",
        "price":"2",
        "amount":"2",
        "discountAmount":"1",
        "takeawayTag":"1"
    },
    {
        "erpCode":"detailErpCode2",
        "departmentId":0,
        "dishesId":"119299336",
        "dishesName":"这是一个测试菜品1",
        "salesQuantity":"",
        "price":"",
        "amount":"",
        "discountAmount":"",
        "takeawayTag":"2"
    }]
}]

Response Json Body¶

名称	类型	可空	描述
code	int	非空	返回的调用状态码 code码
message	String	可空	描述业务非正常处理原因
error	String	可空	描述业务非正常处理的错误码
data	SyncInfo对象	可空	返回值具体信息

SyncInfo对象¶

名称	类型	可空	描述
erpCode	String	非空	第三方erpCode
saleOrderId	Long	非空	第三方同步给我方的业务单id

返回示例¶

    {
    "code": 200,
    "data": [
        {
            "erpCode": "erpCode332",
            "saleOrderId": 6100080
        }
    ],
    "message": null,
    "error": null
}