货流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 | 备注信息 | |
productrequesttemplateName | String | 模板名称 | |
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:ssendTime - 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:对应后台的货流单号 需自己转化为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:已入库 |