货流api
接口地址 | http://host:port/pospal-api2/openapi/v1/stockflowopenapi/queryproductrequestpages | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
starttime | 是 | string | 格式为yyyy-mm-dd hh:mm:ss |
excludeendtime | 是 | string | 格式为yyyy-mm-dd hh:mm:ss endtime - starttime <= 5天 |
postbackparameter | 否 | json | 查询凯发官方首页时可以不传,之后的内容从返回结果中取出 |
parametertype | 是 | string | 从返回结果中取出 |
postbackparameter | 是 | string | 从返回结果中取出 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | list | 实体信息 | |
postbackparameter | json | 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页 | |
parametertype | string | 从返回结果中直接取出用于回传,不能变其值 | |
parametervalue | string | 从返回结果中直接取出用于回传,不能变其值 | |
result | list | 订货单情况—参考根据id查询订货单返回字段 |
接口地址 | http://host:port/pospal-api2/openapi/v1/stockflowopenapi/queryproductrequestbyid | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | a店向b店订货,传a店的appid |
productreuestid | 是 | long | 订货单id |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | json | ||
id | long | 订货单id | |
mergedid | long | 并单时创建新订单的id | |
createuserappid | string | a店向b店订货,这个字段表示a店的appid | |
createuseraccount | string | a店向b店订货,这个字段表示a店的账号 | |
targetuserappid | string | a店向b店订货,这个字段表示b店的appid | |
targetuseraccount | string | a店向b店订货,这个字段表示b店的账号 | |
createddatetime | string | 订货单创建时间 | |
status | int | 订货单状态:已拒绝 = -1, 待审核 = 0, 配货中 = 1, 已完成 = 2, 已作废 = 3,被合并 = -2 | |
alreadypayamount | bigdecimal | 预付款金额 | |
remarks | string | 备注信息 | |
isfinished | int | 是否已配货 0 - 未完成配货 1- 已配货 | |
specifieddeliverytime | string | 指定送货时间 | |
specifiedarrivetime | string | 指定到货时间 | |
cashieruid | long | 收银员uid | |
ordernumber | string | 订货单号 | |
items | list | 订货单中指定的订货商品 | |
productuid | long | 订货商品uid | |
supplieruid | long | 供应商uid | |
quantity | bigdecimal | 订货数量 | |
productunituid | long | 订货门店的订货单位uid,如箱、包、吨quantity-productunituid 3箱、100包0或null表示默认基准单位 | |
pagesize | int | 服务器想返回的条数。result.size为实际返回条数result.size = pageszie时进行下一页查询 | |
processuserappid | string | 进行拆单操作的用户appid,拆单行成的多个配送进各归属于同一个用户。 | |
processuseraccount | string | 进行拆单操作的用户账号,拆单行成的多个配送进各归属于同一个用户。 | |
processitems | list | 拆单情况下有多个配送流程 | |
supplieruid | long | 供货商uid | |
createddatetime | date | 创建时间—>拆单时间 | |
status | int | 预留状态,只能是1=完成状态 | |
stockflowid | long | 调货\进货单id |
接口地址 | http://host:port/pospal-api2/openapi/v1/stockflowopenapi/querystockflowpages | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
starttime | 是 | string | 格式为yyyy-mm-dd hh:mm:ss |
excludeendtime | 是 | string | 格式为yyyy-mm-dd hh:mm:ss endtime - starttime <= 5天 |
postbackparameter | 否 | json | 查询凯发官方首页时可以不传,之后的内容从返回结果中取出 |
parametertype | 是 | string | 从返回结果中取出 |
parametervalue | 是 | string | 从返回结果中取出 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | json | ||
postbackparameter | json | 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页 | |
parametertype | string | 从返回结果中直接取出用于回传,不能变其值 | |
parametervalue | string | 从返回结果中直接取出用于回传,不能变其值 | |
result | list | 货单情况—参考根据货单id查询货单返回字段 |
接口地址 | http://host:port/pospal-api2/openapi/v1/stockflowopenapi/querystockflowdetailbyproductreuqestid | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
productrequestid | 是 | long | 订货单id |
appid | 是 | string | a店向b店订货,传a店的appid |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | list | 详细字段参考根据id查询调货\进货\退货单返回字段 |
接口地址 | http://host:port/pospal-api2/openapi/v1/stockflowopenapi/querystockflowdetailbyid | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
stockflowid | 是 | long | 货流单id |
appid | 是 | string | 如果是出货单,传出货门店appid 如果是进货单,传进货门店appid 对应 querystockflowpages 的touserappid |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
result | json | ||
touserappid | string | 货单指向账号的appid | |
touseraccount | string | 货单指向账号的账号 | |
operatoruserappid | string | 生成货单账号的appid | |
operatoruseraccount | string | 生成货单账号的账号 | |
nextstockflowuserappid | string | 指定下一步货单的touserappid | |
nextstockflowuseraccount | string | 指定下一步货单的touseraccount | |
id | long | 货单id | |
nextstockflowid | long | 下一环节货流id | |
prevstockflowid | long | 上一环节货流id | |
confirmationrequired | int | 是否需要确认货流,1:需要确认,0:不需要确认 | |
createddatetime | date | 1:货单创建时间,格式为yyyy-mm-dd hh:mm:ss 2:当stockflowtypenumber=13,对应后台的货流单号 需自己转化为yyyymmddhhmmss格式 举例: 2021-10-09 15:43:44 对应货流单号:20211009154344 |
|
stockflowtypenumber | int | 进货 = 12, 出货 = 13, 退货 = 14, 调拨退货=16, 出库单=17 | |
confirmed | int | 0- 未确认,1- 已确认, 2- 拒绝进货/出货,3- 被拒绝收货 | |
varianceconfirmation | int | 确认进货时,货流差异时,是否需要确认。出货单和退货单无效1:需要确认,0:不需要确认 | |
paid | bigdecimal | 已支付金额 | |
confirmedtime | date | 确认货流时间,格式为yyyy-mm-dd hh:mm:ss | |
remarks | string | 货单备注信息 | |
productrequestid | long | 订货单id,从哪个订货单生成货(调货\进货)单 | |
updatebycashieruid | long | 进行更新操作的收银员uid | |
items | list | 货单条目 | |
productuid | long | 货单条目商品uid | |
categoryuid | long | 货单条目商品分类uid | |
supplieruid | long | 货单条目商品供应商uid | |
productname | string | 货单条目商品名称 | |
barcode | string | 货单条目商品条码 | |
updatestock | bigdecimal | 按基准单位换算过的货量 | |
actualquantity | bigdecimal | 实际进货量 | |
buyprice | bigdecimal | 进货价 | |
sellprice | bigdecimal | 销售价 | |
item-> remarks | string | 单品备注信息 | |
productunituid | long | 货单条目商品单位uid | |
unitquantity | bigdecimal | 按商品单位的货量 | |
unitbuyprice | bigdecimal | 按商品单位的进货价 |
接口地址 | http://host:port/pospal-api2/openapi/v1/stockflowopenapi/createstockflow | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
接口重点提醒 |
|
||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
stockflow | 是 | json | 货流单详情 |
touserappid | 是 | string | 货流单类型为出货(调货)单时,表示出货门店appid; 货流单类型为进货单时,些字段为进货门店appid; |
nextstockflowuserappid | 否 | string | 货流单类型为出货(调货)单时,此时段表示进货门店appid。 stockflowtypenumber=12时,不需要传 stockflowtypenumber=13时,为必传 |
paid | 是 | bigdecimal | 预付款 |
createddatetime | 是 | string | 格式为yyyy-mm-dd hh:mm:ss |
stockflowtypenumber | 是 | int | 12:进货单, 13:出货(调货)单 |
remarks | 否 | string | 备注内容,100字以内 |
items | 是 | list | |
barcode | 是 | string | 商品条码 进货单时,保证门店有条码对应的商品信息。 出货单时,保证出货门店与进货门店都有条码对应的商品信息。 |
productunituid | 否 | long | 商品单位uid 货流单为出货(调货)时,传出货门店的单位; 货流单为进货单时,传进货门店的单位 |
unitquantity | 是 | bigdecimal | 单位出货量,如 出货 5 箱 |
unitbuyprice | 是 | bigdecimal | 单位进货价,出货价 |
items->remarks | 否 | string | 条目备注内容,100字以内 |
返回结果 | |||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | json | 详添加成功返回货流单实体数据 字段参照根据货单id查询货单 |
接口地址 | http://host:port/pospal-api2/openapi/v1/stockflowopenapi/acceptstockflowout | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
接口重点提醒 |
|
||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
stockflowid | 是 | int | 货流单id |
返回结果 | |||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | json | 详添加成功返回货流单实体数据 字段参照根据货单id查询货单 |
接口地址 | http://host:port/pospal-api2/openapi/v1/stockflowopenapi/acceptstockflowin | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
接口重点提醒 | |||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
stockflowid | 是 | int | 货流单id |
返回结果 | |||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 |
接口地址 | http://host:port/pospal-api2/openapi/v1/stockflowopenapi/rejectstockflowout | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
接口重点提醒 | |||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
stockflowid | 是 | int | 货流单id |
返回结果 | |||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 |
接口地址 | http://host:port/pospal-api2/openapi/v1/stockflowopenapi/rejectstockflowin | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
接口重点提醒 | |||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
stockflowid | 是 | int | 货流单id |
返回结果 | |||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 |
接口地址 | http://host:port/pospal-api2/openapi/v1/stockflowopenapi/queryproductpurchasepages | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
starttime | 是 | string | 格式为yyyy-mm-dd hh:mm:ss |
excludeendtime | 是 | string | 格式为yyyy-mm-dd hh:mm:ss endtime - starttime <= 5天 |
postbackparameter | 否 | json | 查询凯发官方首页时可以不传,之后的内容从返回结果中取出 |
parametertype | 是 | string | 从返回结果中取出 |
postbackparameter | 是 | string | 从返回结果中取出 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | list | 实体信息 | |
postbackparameter | json | 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页 | |
parametertype | string | 从返回结果中直接取出用于回传,不能变其值 | |
parametervalue | string | 从返回结果中直接取出用于回传,不能变其值 | |
result | list | 采购单列表 | |
uid | long | 采购单在银豹的唯一标识 | |
ordernumber | string | 采购单号 | |
supplieruid | long | 供应商在银豹的唯一标识 | |
suppliername | string | 供应商名称 | |
purchasenum | bigdecimal | 采购总数量(实际入库量以货流入库单为主) | |
purchaseamount | bigdecimal | 采购金额(实际金额以货流入库单为主) | |
status | int | 采购单状态 0:待入库 1:已入库 -1:已作废 | |
createddatetime | string | 制单日期 | |
remarks | string | 备注 | |
items | list | 采购单明细列表 | |
productpurchaseuid | long | 采购单在银豹的唯一标识, productpurchase.uid=item. productpurchaseuid | |
productuid | long | 采购商品在银豹的唯一标识 | |
quantity | bigdecimal | 采购量(实际入库量以货流入库单为主) | |
giftquantity | bigdecimal | 赠送量(实际入库量以货流入库单为主) | |
purchaseprice | bigdecimal | 采购价 | |
remark | string | 备注 | |
processitems | list | 采购已处理列表 | |
stockflowid | long | 货流id | |
createddatetime | string | 操作时间 | |
status | int | 状态 1:已入库 |