开放平台二期接口目录 (进销存大部分基础接口/采购单据查询接口)
术语表
采购单 purchase_sheet
供应商 supplier
入库单 in_stock_sheet
出库单 out_stock_sheet
供应商退货单 supplier_return_sheet
商户退货条目 customer_return
商户退货单 customer_return_sheet
库存 stock
盘库 edit_stock
总账 ledger
提交 submit
冲销 cancel
审核不通过 audit_no_pass
采购sku spec
数据结构
采购
采购单列表
接口: v1/api/purchase/purchase_sheet/list/1.0
station接口: /stock/purchase_sheet/get
Method: GET
请求:
start_time M 起始时间
end_time M 截止时间
sheet_id O 单据id
status O 状态 (已提交2/未提交3)
supplier_id O 供应商id
offset O int 分页offset,默认0
limit O int 分页limit,默认20,最大100
($q:要货状态?)
响应:
{
"code": 0,
"data": [{
"create_time": "2019-09-04 11:44:59", 创建时间
"purchase_sheet_id": "T32573-CGD-2019-09-04-00001", 采购单id
"station_id": "T32573", 站点id
"status": 2, 单据状态
"submit_time": "2019-09-04T11:45:04.847", 提交时间
"supplier_id": "T39727", 供应商id
"supplier_name": "冻品供应商", 供应商名字
"purchase_task_num": 3, 采购任务数
"purchase_money": 442, 采购金额
"in_stock_time": "2019-09-04T00:00:00", 入库时间
"purchaser": "平台测试张三", 采购员
"purchaser_id": 201711, 采购员id
"operator": "pt_test01", 建单员
"operator_id": 16979 建单员id
}],
"pagenation": {
'offset'
'limit'
},
"msg": "ok"
}
采购单详情
接口: v1/api/purchase/purchase_sheet/get/1.0
station接口: /stock/purchase_sheet/detail
Method: GET
请求:
purchase_sheet_id M 采购单id
响应:
{
"code": 0,
"data": {
"create_time": "2019-09-04 11:44:59", 创建时间
"purchase_sheet_id": "T32573-CGD-2019-09-04-00001", 采购单id
"station_id": "T32573", 站点id
"station_name": "平台对接测试总仓", 站点名
"status": 2, 单据状态
"submit_time": "2019-09-04T11:45:04.847", 提交时间
"supplier_id": "T39727", 供应商id
"supplier_name": "冻品供应商", 供应商名字
"operator": "pt_test01", 建单员
"task": [{
"spec_id": "D16957574", 采购skuid
"spec_name": "越南乳猪|1斤/斤", 采购sku名
"category1_name": "冷冻品", 一级分类名
"category2_name": "猪", 二级分类名
"pinlei_name": "猪", 品类名
"purchase_unit_name": "斤", 采购单位
"purchase_std_unit_name": "斤", 采购基本单位
"purchase_price": 34, 采购价,单位元
"plan_count": "13", 计划采购数
"purchase_count": "13", 采购数
"already_purchased_count": "13", 已采购数
"sale_ratio": "1", 采购规格
}]
},
"msg": "ok"
}
进销存
供应商
查询供应商列表
接口: v1/api/stock/supplier/list/1.0
station接口: /supplier/search
Method: GET
请求:
search_text O 匹配供应商名字,编号,电话
offset O int 分页offset,默认0
limit O int 分页limit,默认20,最大100
响应:
{
"code": 0,
"data": {
"supplier_id": 'T32578', 供应商id
'supplier_name': '蔬菜供应商', 供应商名字
'supplier_no': 'SCGYS', 供应商编号
'supplier_phone': 11111 供应商电话(null=true)
},
"pagenation": {
'offset'
'limit'
},
"msg": "ok"
}
查询供应商详情
接口: v1/api/stock/supplier/get/1.0
station接口: /supplier/detail
Method: GET
请求:
supplier_id M 供应商id
响应:
{
"code": 0,
"data": {
"supplier_id": 'T32578', 供应商id
'supplier_name': '蔬菜供应商', 供应商名字
'supplier_no': 'SCGYS', 供应商编号
'supplier_phone': 11111, 供应商电话(null=true)
'pay_method': 1, 结款方式
'company_address': '', 供应公司地址(null=true)
'company_name': '', 供应公司名(null=true)
'category2': [{
"category2_id": 'B69851',
"category2_name": '腌制品'
}]
},
"msg": "ok"
}
采购入库单
查询采购入库单列表
接口: v1/api/stock/in_stock_sheet/list/1.0
station接口: /stock/in_stock_sheet/material/list
Method: GET
请求:
start_time M 起始时间
end_time M 截止时间
in_stock_sheet_id O 单据id
status O 状态 (-1已删除/0审核不通过/1待提交/2已提交待审核/3审核通过待借款/4已结款/5全部)
响应: ($q: 是否加入detail)
{
"code": 0,
"data": [{
"in_stock_sheet_id": "T32573-JHD-2019-09-06-00001", 入库单id
"status": 2, 状态
"create_time": "2019-09-06", 建单时间
"total_money": "12", 入库金额
"supplier_name": "冻品供应商", 供应商名
"supplier_no": "DPGYS", 供应商编号
"supplier_id": "T39727", 供应商id
"submit_time": "2019-09-06", 提交时间
}],
"msg": "ok"
}
查询采购入库单详情
接口: v1/api/stock/in_stock_sheet/get/1.0
station接口: /stock/in_stock_sheet/material/new_detail
Method: GET
请求:
in_stock_sheet_id M 单据id
响应:
{
"code": 0,
"data": {
"in_stock_sheet_id": "T32573-JHD-2019-09-06-00001", 入库单id
"status": 2, 状态
"create_time": "2019-09-06", 建单时间
"total_money": "12", 入库金额
"supplier_name": "冻品供应商", 供应商名
"supplier_no": "DPGYS", 供应商编号
"supplier_id": "T39727", 供应商id
"submit_time": "2019-09-06", 提交时间
"details": [{
spu_id
spu_name
std_unit 基本单位
purchase_unit 采购单位
spec_id 采购skuid
quantity 入库数(采购单位)
unit_price 入库单价(采购单位)
ratio 规格
}],
},
"msg": "ok"
}
新建采购入库单
接口: v1/api/stock/in_stock_sheet/create/1.0
station接口: /stock/in_stock_sheet/material/create /stock/in_stock_sheet/material/modify
Method: POST
请求:
supplier_id M 供应商id
响应:
{
"code": 0,
"data": {
in_stock_sheet_id 单据id
},
"msg": "ok"
}
修改采购入库单
接口: v1/api/stock/in_stock_sheet/update/1.0
station接口: /stock/in_stock_sheet/material/modify
Method: POST
请求:
in_stock_sheet_id M 单据id
响应:
{
"code": 0,
"data": ,
"msg": "ok"
}
采购入库单冲销
接口: v1/api/stock/in_stock_sheet/cancel/1.0
station接口: /stock/in_stock_sheet/cancel
Method: GET
请求:
in_stock_sheet_id M 入库单id
响应:
{
"code": 0,
"data": ,
"msg": "ok"
}
采购入库单审核不通过
接口: v1/api/stock/in_stock_sheet/audit_no_pass/1.0
station接口: /stock/in_stock_sheet/review
Method: GET
请求:
in_stock_sheet_id M 入库单id
响应:
{
"code": 0,
"data": ,
"msg": "ok"
}
采购退货单
查询采购退货单列表
接口: v1/api/stock/supplier_return_sheet/list/1.0
station接口: /stock/return_stock_sheet/list
Method: GET
请求:
supplier_id M 供应商id
响应:
{
"code": 0,
"data": [{
}],
"msg": "ok"
}
查询采购退货单详情
接口: v1/api/stock/supplier_return_sheet/get/1.0
station接口: /stock/return_stock_sheet/detail
Method: GET
请求:
supplier_id M 供应商id
响应:
{
"code": 0,
"data": {
},
"msg": "ok"
}
新建采购退货单
接口: v1/api/stock/supplier_return_sheet/create/1.0
station接口: /stock/return_stock_sheet/create /stock/return_stock_sheet/modify
Method: POST
请求:
supplier_id M 供应商id
响应:
{
"code": 0,
"data": {
},
"msg": "ok"
}
修改采购退货单
接口: v1/api/stock/supplier_return_sheet/update/1.0
station接口: /stock/return_stock_sheet/modify
Method: POST
请求:
supplier_id M 供应商id
响应:
{
"code": 0,
"data": {
},
"msg": "ok"
}
采购退货单冲销
接口: v1/api/stock/supplier_return_sheet/cancel/1.0
station接口: /stock/return_stock_sheet/cancel
Method: POST
请求:
supplier_return_sheet_id M 采购退货单id
响应:
{
"code": 0,
"data": ,
"msg": "ok"
}
采购退货单审核不通过
接口: v1/api/stock/supplier_return_sheet/audit_no_pass/1.0
station接口: /stock/return_stock_sheet/review
Method: POST
请求:
supplier_return_sheet_id M 采购退货单id
响应:
{
"code": 0,
"data": ,
"msg": "ok"
}
销售出库
出库单列表
接口: v1/api/stock/out_stock_sheet/list/1.0
station接口: /stock/out_stock_sheet/list
Method: GET
请求:
supplier_id M 供应商id
响应:
{
"code": 0,
"data": [{
}],
"msg": "ok"
}
出库单详情
接口: v1/api/stock/out_stock_sheet/get/1.0
station接口: /stock/out_stock_sheet/detail
Method: GET
请求:
supplier_id M 供应商id
响应:
{
"code": 0,
"data": {
},
"msg": "ok"
}
新建出库单
接口: v1/api/stock/out_stock_sheet/create/1.0
station接口: /stock/out_stock_sheet/create
Method: POST
请求:
out_stock_sheet_id M 出库单id 自定义id 检查重复
响应:
{
"code": 0,
"data": {
out_stock_sheet_id 出库单id
},
"msg": "ok"
}
修改出库单
接口: v1/api/stock/out_stock_sheet/update/1.0
station接口: /stock/out_stock_sheet/modify
Method: POST
请求:
out_stock_sheet_id M 出库单id
响应:
{
"code": 0,
"data": ,
"msg": "ok"
}
确认出库
接口: v1/api/stock/out_stock_sheet/submit/1.0
station接口: /stock/out_stock_sheet/modify
Method: POST
请求:
out_stock_sheet_id M 出库单id
响应:
{
"code": 0,
"data": ,
"msg": "ok"
}
出库单冲销
接口: v1/api/stock/out_stock_sheet/cancel/1.0
station接口: /stock/out_stock_sheet/cancel
Method: POST
请求:
out_stock_sheet_id M 出库单id
响应:
{
"code": 0,
"data": ,
"msg": "ok"
}
退货入库
拉取待退货条目
接口: v1/api/stock/customer_return/list/1.0
station接口: station/refund/list
Method: GET
请求:
start_time M 起始时间
end_time M 截止时间
solution O 处理方式
order_id O 订单号
响应:
{
"code": 0,
"data": {
},
"msg": "ok"
}
拉取退货单列表 (由流水拼凑出单据)
接口: v1/api/stock/customer_return_sheet/list/1.0
station接口: /stock/refund_stock_sku
Method: GET
请求:
start_time M 起始时间
end_time M 截止时间
order_id O 订单号
响应:
{
"code": 0,
"data": [{
customer_return_sheet_id 退货单id
}],
"msg": "ok"
}
退货单提交(新建)
接口: v1/api/stock/customer_return_sheet/submit/1.0
station接口: station/refund/edit
Method: POST
请求:
customer_return_id M 退货条目id
solution M 处理方式 放弃取货/二次入库
request_count M 应退数
real_count M 实退数
supplier_id O 供应商id
响应:
{
"code": 0,
"data": {
customer_return_sheet_id 退货单id
},
"msg": "ok"
}
库存
库存盘点列表(按商品)
接口: v1/api/stock/list/1.0
station接口: stock/list
Method: GET
请求:
category1_id O 一级分类id
category2_id O 二级分类id
status O 库存状态(1大于0/2等于0/3小于0)
响应:
{
"code": 0,
"data": {
"spu_id": "C2480129", spu_id
"spu_name": "", spu名
"category1_id": "", 一级分类id
"category1_name": "", 一级分类名
"category2_id": "", 二级分类id
"category2_name": "", 二级分类名
"remain": "", 库存
"avg_price": "", 库存均价
"frozen_count": "", 冻结库存
"std_unit_name": "", 基本单位
"available_stock": "", 可用库存
},
"msg": "ok"
}
库存详情(先进先出/待定)
接口: v1/api/stock/get/1.0
station接口:
Method: GET
请求:
supplier_id M 供应商id
响应:
{
"code": 0,
"data": {
},
"msg": "ok"
}
修改库存(盘库)
接口: v1/api/stock/edit_stock/1.0
station接口: /stock/edit
Method: POST
请求:
spu_id M 供应商id
remain M 实盘数
remark O 备注
响应:
{
"code": 0,
"data": ,
"msg": "ok"
}
应付总账
应付总账列表
接口: v1/api/stock/ledger/list/1.0
station接口: /station/stock/report/settlement/list
Method: GET
请求:
start_time M 起始时间
end_time M 截止时间
supplier_id O 供应商id
响应:
{
"code": 0,
"data": [{
"supplier_name": "冻品供应商", 供应商名
"supplier_no": "DPGYS", 供应商编号
"supplier_id": "T39727", 供应商id
early_unpay 期初未支付
cur_should_pay 本期应付
cur_pay 本期已付
total_unpay 期末未支付
}],
"msg": "ok"
}
应付总账明细
接口: v1/api/stock/ledger/get/1.0
station接口: /station/stock/report/settlement/detail
Method: GET
请求:
start_time M 起始时间
end_time M 截止时间
supplier_id O 供应商id
响应:
{
"code": 0,
"data": [{
}],
"msg": "ok"
}