简要描述:
- 采购入库单查询接口
接口说明:
- 1.1接口描述:查询采购入库单接口
- 1.2增量获取:按照采购单的最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。
- 1.3时间跨度:时间跨度:start_time和end_time最大跨度为30天,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,建议根据获取数据量的多少适当减小时间跨度。
- 1.4注意事项:该接口最终是查询OMS系统中的采购入库单信息,如果入参中有上层单据编号src_order_no(默认为采购单号),则会走OMS开放平台的标准接口,如果没有该参数则走奇门OMS接口,根据开始时间start_time和结束时间end_time批量获取供应商档案信息
接口版本:
| 版本号 | 制定人 | 制定日期 | 修订日期 |
|---|---|---|---|
| 1.0.0 | 黄会准 | 2020-07-20 | 2020-07-20 |
请求URL:
请求方式:
- POST
请求头:
| 参数名 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| X-AUTH-TOKEN | 是 | string | 令牌 |
| Content-Type | 是 | string | 请求类型,统一是 application/json |
请求参数:
| 参数名 | 字段 | 是否必须 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
| 开始时间 | start_time | 是 | datetime | 按最后修改时间增量获取数据,start_time作为开始时间,格式:yyyy-MM-dd HH:mm:ss | |
| 结束时间 | end_time | 是 | datetime | 按最后修改时间增量获取数据,end_time作为结束时间,格式:yyyy-MM-dd HH:mm:ss | |
| 上层单据编号 | src_order_no | 否 | varchar | 40 | 上层单据编号,默认为采购单号,传该字段可以不传开始时间和结束时间 |
| 仓库编号 | warehouse_no | 否 | varchar | 40 | 代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置) |
| 分页大小 | page_size | 否 | int | 10 | 每页返回的数据条数,输入值范围1~50,不传本参数,输入值默认为30 |
| 页号 | page_no | 否 | int | 10 | 不传值默认从0页开始 |
| 入库单状态 | status | 否 | tinyint | 4 | 入库单状态 10已取消20编辑中25待价格确认30待审核60待结算80已完成(默认80) |
返回参数说明:
| 参数名 | 字段 | 是否必须 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
| 状态码 | code | 是 | int | 11 | 状态码:1表示成功,其他表示失败 |
| 返回信息 | msg | 是 | varchar | 255 | 错误原因 |
| 请求id | requestId | 是 | varchar | 255 | 请求后,返回唯一id(成功与否都会返回) |
| 返回数据 | data | 是 | object | 请求成功后返回相应数据 |
data
| 参数名 | 字段 | 类型 | 说明 |
|---|---|---|---|
| 纠错数量 | adjust_num | decimal | 调整量,正数或者负数,小数点后四位 |
| 纠错金额 | adjust_price | decimal | 纠错金额,小数点后四位 |
| 审核时间 | check_time | datetime | 审核时间,格式:yyyy-MM-dd HH:mm:ss |
| 创建时间 | created_time | datetime | 创建时间,格式:yyyy-MM-dd HH:mm:ss |
| 明细节点 | details_list | data[] | 响应参数的2级数据节点,包含采购入库货品明细属性信息,节点下数据字段详见下述“details_list” |
| 优惠 | discount | decimal | 优惠 |
| 货款总额 | goods_amount | decimal | 货款总额 |
| 货品总数量 | goods_count | decimal | 货品总数量 |
| 物流公司编号 | logistics_code | String | 旺店通系统内物流公司编号 |
| 物流公司名称 | logistics_name | String | 旺店通系统内物流公司名称 |
| 物流单号 | logistics_no | String | 物流单号 |
| 物流类型 | logistics_type | int | 代表供应商所有属性的唯一编码,用于供应商区分 |
| 入库单号 | order_no | String | 入库单号 |
| 入库类型 | order_type | tinyint | 入库类型(该接口只返回采购入库类型) |
| 入库类型名称 | order_type_name | String | 入库类型名称(默认为采购入库) |
| 其他费用 | other_fee | decimal | 其他费用 |
| 外部单号 | outer_no | String | 上层单据的采购单号可做该入库单的外部单号 |
| 邮费 | post_fee | String | 邮费 |
| 供应商名称 | provider_name | String | 供应商名称 |
| 供应商编码 | provider_no | String | 供应商编码 |
| 采购单编号 | purchase_no | String | 采购单编号 |
| 备注 | remark | String | 备注 |
| 调整后数量 | right_nums | decimal | 调整后数量 |
| 调整后总金额 | right_price | String | 调整后总金额 |
| 采购单号 | src_order_no | String | 采购单号 |
| 状态 | status | tinyint | 状态 |
| 入库单主键id | stockin_id | String | 入库单主键id |
| 入库原因 | stockin_reason | String | 入库原因 |
| 修改时间 | stockin_time | datetime | 修改时间 |
| 税后金额 | tax_amount | decimal | 税后金额 |
| 总成本 | total_price | decimal | 总成本 |
| 仓库 | warehouse_name | String | 仓库 |
| 仓库编号 | warehouse_no | String | 仓库编号 |
details_list
| 参数名 | 字段 | 类型 | 说明 |
|---|---|---|---|
| 纠错数量 | adjust_num | decimal | 调整量,正数或者负数,小数点后四位 |
| 纠错金额 | adjust_price | decimal | 纠错金额,小数点后四位 |
| 批次号 | batch_no | decimal | 批次号 |
| 批次备注 | batch_remark | decimal | 批次备注 |
| 品牌名称 | brand_name | String | 品牌名称 |
| 品牌编号 | brand_no | String | 品牌编号 |
| 单价 | cost_price | decimal | 单价,小数点后四位 |
| 优惠金额 | discount | decimal | 优惠金额,小数点后四位 |
| 有效期 | expire_date | decimal | 有效期 |
| 货品数量 | goods_count | decimal | 货品数量,小数点后四位 |
| 货品名称 | goods_name | String | 货品名称 |
| 货品编号 | goods_no | String | 货品编号 |
| 单位名称 | goods_unit | String | 单位名称 |
| 货位编号 | position_no | String | 货位编号 |
| 生产日期 | production_date | datetime | 生产日期 |
| 自定义属性 | prop2 | String | 自定义属性 |
| 入库明细主键 | rec_id | int | 入库明细主键 |
| 备注 | remark | String | 备注 |
| 调整后总金额 | right_cost | decimal | 调整后总金额,小数点后四位 |
| 调整后数量 | right_num | decimal | 调整后数量,小数点后四位 |
| 调整后单价 | right_price | decimal | 调整后单价,小数点后四位 |
| 规格码 | spec_code | String | 规格码 |
| 规格名称 | spec_name | String | 规格名称 |
| 商家编码 | spec_no | String | 代表单品(sku)所有属性的编码 |
| 上层单据明细主键 | src_order_detail_id | int | 上层单据明细主键 |
| 原价 | src_price | decimal | 原价,小数点后四位 |
| 入库单主键id | stockin_id | int | 入库单主键id |
| 税后价 | tax_price | decimal | 税后价,小数点后四位 |
| 总成本 | total_cost | decimal | 总成本,小数点后四位 |
| 有效期天数 | validity_days | int | 有效期天数 |
请求参数示例–传src_order_no示例–精准查询
{
"src_order_no":"CG202007130030",
"status":80
}返回示例:
正确时返回:
{
"code": "1",
"data": [
{
"adjust_num": 0.0000,
"adjust_price": 0.0000,
"check_time": "2020-08-04 18:05:03",
"created_time": "2020-08-04 17:51:56",
"details_list": [
{
"adjust_num": 0.0000,
"adjust_price": 0.0000,
"batch_no": "",
"batch_remark": "",
"brand_name": "无",
"brand_no": "BD201911060035",
"cost_price": 90.0000,
"discount": 0.0000,
"expire_date": -62170185600000,
"goods_count": 120.0000,
"goods_name": "君乐宝乐畅800克桶3段",
"goods_no": "6922577726852",
"goods_unit": "",
"position_no": "ZANCUN",
"production_date": -62170185600000,
"prop2": "",
"rec_id": "16919851",
"remark": "",
"right_cost": 10800.0000,
"right_num": 120.0000,
"right_price": 90.0000,
"spec_code": "6922577726852",
"spec_name": "",
"spec_no": "6922577726852",
"src_order_detail_id": "12459",
"src_price": 90.0000,
"stockin_id": "5768790",
"tax_price": 105.3000,
"total_cost": 10800.0000,
"validity_days": 0
}
],
"discount": 0.0000,
"goods_amount": 10800.0000,
"goods_count": 120.0000,
"logistics_code": "",
"logistics_name": "无",
"logistics_no": "",
"logistics_type": 0,
"order_no": "WDTRK2008045001",
"order_type": 1,
"order_type_name": "采购入库",
"other_fee": "0.0000",
"outer_no": "PI0002001052048",
"post_fee": 0.0000,
"provider_name": "青岛梦唯诗电子商务有限公司",
"provider_no": "1071",
"purchase_no": "PI0002001052048",
"remark": "",
"right_nums": 120.0000,
"right_price": 10800.0000,
"src_order_no": "PI0002001052048",
"status": "80",
"stockin_id": 5768790,
"stockin_reason": "",
"stockin_time": "2020-08-04 18:05:03",
"tax_amount": "12636.0000",
"total_price": "10800.0000",
"warehouse_name": "guanqiang2-test",
"warehouse_no": "guanqiang2-test"
}
],
"flag": "success",
"msg": "success",
"requestId": "e685437528de40a7a88557658c831092"
}错误时返回:
{
"errcode": 500,
"errmsg": "invalid appid"
}请求参数示例–增量查询
{
"start_time":"2020-07-19 01:00:00",
"end_time":"2020-07-19 02:00:00"
}返回参数说明:
| 参数名 | 字段 | 是否必须 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
| 状态码 | code | 是 | int | 11 | 状态码:1表示成功,其他表示失败 |
| 返回信息 | msg | 是 | varchar | 255 | 错误原因 |
| 请求id | requestId | 是 | varchar | 255 | 请求后,返回唯一id(成功与否都会返回) |
| 返回数据 | data | 是 | object | 请求成功后返回相应数据 |
返回示例:
正确时返回:
{
"code": "1",
"data": [],
"msg": "SUCCESS",
"requestId": "bb21cdb49795426194ad6115b3847519"
}错误时返回:
{
"code": "failure",
"flag": "failure",
"msg": "奇门API系统调用异常",
"requestId": "1a6331a432ab46bf9bf71c58a6ae762c",
"subCode": "200000",
"subMsg": "【{\"response\":{\"flag\":\"failure\",\"code\":15,\"message\":\"Remote service error\",\"sub_code\":\"2150\",\"sub_message\":\"end_time不能晚于当前时间\",\"request_id\":\"847j9e6g9wwx\"}}】"
}备注:
- 更多返回错误代码请看首页的错误代码描述
文档更新时间: 2020-12-07 10:59 作者:黄会准