当前位置: API文档
purchase_order_query.php(查询采购单)
| 1.1 接口描述:获取旺店通ERP的采购单及其明细信息 |
| 1.2 适用版本:客户端 V2.4.5.0及以上版本 |
| 1.3 增量获取:按照采购单的最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。 |
| 1.4 时间跨度:start_time和end_time最大跨度为30天,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,建议根据获取数据量的多少适当减小时间跨度。 |
| 2.1 财务系统、SAP、数据分析等系统的对接 |
| 环境 | HTTP地址 |
|---|---|
| 测试环境 | https://sandbox.wangdian.cn/openapi2/purchase_order_query.php |
| 正式环境 | https://api.wangdian.cn/openapi2/purchase_order_query.php |
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 卖家账号 | sid | String | 是 | 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 | |
| 接口账号 | appkey | String | 是 | 本开放平台“自助对接”功能模块内自助申请,获取方式点击这里 | |
| 时间戳 | timestamp | int | 是 | 北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。 | |
| 签名 | sign | String | 是 | API输入参数签名结果,签名算法介绍单击这里 |
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 采购单号 | purchase_no | varchar | 40 | 否 | ERP系统采购单编号,传该字段可以不传开始时间和结束时间 |
| 外部单号 | outer_no | varchar | 40 | 否 | ERP推送采购单外部返回单号(对应外部仓储单号) 传该字段可以不传开始时间和结束时间 |
| 采购单状态 | status | tinyint | 否 | 10 已取消,20 编辑中,30 待审核,35 待财审,40 已审核,43 待推送,45 推送失败,48 待收货,50 部分到货,60已到货,70 待结算,80 部分结算,90 已完成(不传默认查询全部状态采购单) | |
| 开始时间 | start_time | datetime | 是 | 按最后修改时间增量获取数据,start_time作为开始时间,格式:yyyy-MM-dd HH:mm:ss | |
| 结束时间 | end_time | datetime | 是 | 按最后修改时间增量获取数据,end_time作为结束时间,格式:yyyy-MM-dd HH:mm:ss | |
| 仓库编号 | warehouse_no | varchar | 40 | 否 | 代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置) |
| 分页大小 | page_size | int | 否 | 每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40,使用举例单击这里 | |
| 页号 | page_no | int | 否 | 页号默认从0开始 |
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 错误码 | code | int | 是 | 错误码,0成功 | |
| 错误描述 | message | varchar | 是 | 错误描述 | |
| 数据总条数 | total_count | int | 是 | 符合条件的数据总条数,当page_no=0时返回,用来分页 | |
| 采购单列表节点 | purchase_list | data[] | 是 | 响应参数的1级数据节点,包含当前页的采购单及其明细的数据节点,节点下数据字段详见下述" purchase_list"和“details_list” |
purchase_list
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 采购单id | purchase_id | int | 11 | 是 | 采购单id,采购单表主键 |
| 采购单号 | purchase_no | varchar | 40 | 是 | ERP系统采购单编号 |
| 外部单号 | purchase_outer_no | varchar | 40 | 是 | ERP推送采购单外部返回单号(对应外部仓储单号)。 ERP客户端需升级至V2.3.8.6及以上版本可获取此字段 |
| api单号 | outer_no | varchar | 40 | 是 | 通过接口创建采购单时传的api单号 |
| 仓库 | warehouse_name | varchar | 64 | 是 | 仓库名称 |
| 仓库编号 | warehouse_no | varchar | 40 | 是 | 代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置) |
| 采购单状态 | status | tinyint | 4 | 是 | 采购单状态:10 已取消,20 编辑中,30 待审核,35 待财审,40 已审核,43 待推送,45 推送失败,48 待收货,50 部分到货,60已到货,70 待结算,80 部分结算,90 已完成 |
| 供应商编号 | provider_no | varchar | 20 | 是 | 供应商编号 |
| 供应商名称 | provider_name | varchar | 64 | 是 | 供应商名称 |
| 联系人 | contact | varchar | 40 | 是 | 联系人 |
| 电话 | telno | varchar | 40 | 是 | 电话 |
| 采购员 | purchaser_name | varchar | 20 | 是 | 采购员 |
| 收货地址 | receive_address | varchar | 512 | 是 | 收货地址 |
| 货运方式 | logistics_type | smallint | 6 | 是 | 货运方式 |
| 审核时间 | check_time | datetime | 是 | 审核时间,格式:yyyy-MM-dd HH:mm:ss | |
| 货款 | goods_amount | decimal | (19,4) | 是 | 货款 |
| 邮资 | post_fee | decimal | (19,4) | 是 | 邮资 |
| 其他费用 | other_fee | decimal | (19,4) | 是 | 其他费用 |
| 税后货品总金额 | tax_goods_amount | decimal | (19,4) | 是 | 税后货品总金额 |
| 备注 | remark | varchar | 255 | 是 | 采购单备注 |
| 最后修改时间 | modified | datetime | 是 | 单据的最后修改时间,格式:yyyy-MM-dd HH:mm:ss | |
| 预计到货时间 | expect_arrive_time | datetime | 是 | 采购预计到货时间,格式:yyyy-MM-dd HH:mm:ss | |
| 自定义属性1 | prop1 | varchar | 255 | 是 | 自定义属性1 |
| 自定义属性2 | prop2 | varchar | 255 | 是 | 自定义属性2 |
| 创建时间 | created | datetime | 是 | 单据创建时间,格式:yyyy-MM-dd HH:mm:ss | |
| 创建人id | creator_id | int | 11 | 是 | 默认为'0',创建人id |
| 创建人姓名 | creator_name | varchar | 40 | 是 | 默认为'0',创建人姓名 |
| 仓库id | warehouse_id | int | 11 | 是 | 仓库id |
| api外部单号 | api_outer_no | varchar | 40 | 是 | 默认为'',接口创建的单据的外部单号,同outer_no |
| 外部仓库单号 | wms_outer_no | varchar | 40 | 是 | 默认为'',对应外部仓库的单号,同purchase_outer_no字段 |
| 外部状态 | wms_status | tinyint | 4 | 是 | 默认为'0',外部状态,与wms对接使用 0初始化 1失败 2成功 |
| 错误信息 | error_info | varchar | 200 | 否 | 默认为'',返回错误信息 |
| 采购员id | purchaser_id | int | 11 | 是 | 默认为'0',采购员id |
| 采购单类型 | order_type | int | 11 | 是 | 默认为'0',0普通采购单,1档口采购单,2APP档口采购单 |
| 颜色标记 | flag_id | int | 11 | 是 | 默认为'0',颜色标记 |
| 供应商 | provider_id | int | 11 | 是 | 默认为'0',供应商 |
| 审核人 | check_operator_id | int | 11 | 是 | 默认为'0',审核人 |
| 财审人 | facheck_operator_id | int | 11 | 是 | 默认为'0',财审人 |
| 财审时间 | facheck_time | datetime | 是 | 默认为'0000-00-00 00:00:00',财审时间 | |
| 货品总价 | goods_fee | decimal | (19,4) | 是 | 默认为'0.0000',货品总价 |
| 货品数量 | goods_count | decimal | (19,4) | 是 | 默认为'0.0000',货品数量 |
| 税后总价 | tax_fee | decimal | (19,4) | 是 | 默认为'0',税后总价 |
| 货品种类 | goods_type_count | smallint | 6 | 是 | 默认为'0',货品种类 |
| 到货总量 | goods_arrive_count | decimal | (19,4) | 是 | 默认为'0.0000',到货总量 |
| 驳回原因 | revert_reason | int | 11 | 否 | 默认为'0',驳回原因 |
| 版本号 | version_id | int | 11 | 是 | 默认为'0',版本号 |
| 便签条数 | note_count | smallint | 6 | 是 | 默认为'0',便签条数 |
| 自定义属性时间1 | prop_time1 | datetime | 是 | 默认为'0000-00-00 00:00:00',自定义属性时间1 | |
| 审核员名称 | check_operator_name | varchar | 40 | 是 | 审核员名称 |
| 财审员名称 | facheck_operator_name | varchar | 40 | 是 | 财审员名称 |
| 采购单明细节点 | details_list | data[] | 响应参数的2级数据节点,,节点下数据字段详见下述“details_list” |
details_list
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 主键 | rec_id | int | 11 | 是 | 采购明细表主键id |
| 采购单id | purchase_id | int | 11 | 是 | 采购单id |
| 商家编码 | spec_no | varchar | 40 | 是 | 代表单品(sku)所有属性的编码,SKU概念介绍,单击这里 |
| 品牌 | brand_name | varchar | 64 | 是 | 品牌名称,推送此字段前需将版本升级至V2.3.9.1及以上的稳定版本 |
| 数量 | num | decimal | (19,4) | 是 | 数量 |
| 税前单价 | price | decimal | (19,4) | 是 | 税前单价 |
| 折扣 | discount | decimal | (19,4) | 是 | 折扣 |
| 税率 | tax | decimal | (19,4) | 是 | 税率 |
| 税后单价 | tax_price | decimal | (19,4) | 是 | 税后单价 |
| 税后金额 | tax_amount | decimal | (19,4) | 是 | 税后金额 |
| 税前金额 | amount | decimal | (19,4) | 是 | 税前金额 |
| 采购到货入库总金额 | stockin_amount | decimal | (19,4) | 是 | 采购到货入库总金额 |
| 采购到货入库数量 | stockin_num | decimal | (19,4) | 是 | 采购到货入库数量 |
| 自定义属性1 | prop1 | varchar | 255 | 是 | 自定义属性1 |
| 自定义属性2 | prop2 | varchar | 255 | 是 | 自定义属性2 |
| 备注 | remark | varchar | 255 | 是 | 明细备注 |
| 修改时间 | modified | datetime | 是 | 修改时间,格式:yyyy-MM-dd HH:mm:ss | |
| 供应商货品编号 | provider_goods_no | varchar | 40 | 是 | 供应商货品编号 |
| 货品编号 | goods_no | varchar | 40 | 是 | 货品编号 |
| 货品名称 | goods_name | varchar | 255 | 是 | 货品名称 |
| 货品简称 | short_name | varchar | 255 | 是 | 货品简称 |
| 规格名称 | spec_name | varchar | 255 | 是 | 规格名称 |
| 规格码 | spec_code | varchar | 40 | 是 | 规格码 |
| 基本单位 | base_unit | varchar | 20 | 是 | 基本单位 |
| 采购单位 | purchase_unit | varchar | 20 | 是 | 采购单位 |
| 采购到货未入库数量 | arrive_num | decimal | (19,4) | 是 | 采购到货未入库数量 |
| 停止等待数量 | stopwait_num | decimal | (19,4) | 是 | 停止等待数量 |
| 采购价 | purchase_price | decimal | (19,4) | 是 | 采购价 |
| 最后采购价 | last_price | decimal | (19,4) | 是 | 最后采购价 |
| 上一次采购价 | last_second_price | decimal | (19,4) | 是 | 上一次采购价 |
| 最低采购价 | lowest_price | decimal | (19,4) | 是 | 最低采购价 |
| 重量 | weight | decimal | (19,4) | 是 | 重量 |
| 多到货量 | arrive_more_num | decimal | (19,4) | 是 | 多到货量 |
| 未到货量 | lack_num | decimal | (19,4) | 是 | 未到货量 |
| 规格id | spec_id | int | 11 | 是 | 规格id |
| 仓库id | warehouse_id | int | 11 | 是 | 默认为'0',仓库id |
| 标签 | tag | tinyint | 4 | 是 | 默认为'0', tag=0表示默认采购 |
| 数量2 | num2 | decimal | (19,4) | 是 | 默认为'0.0000',辅助单位数量 |
| 单位比率 | unit_ratio | decimal | (19,4) | 是 | 默认为'1.0000',基本单位和辅助单位的换算系数 |
| 辅助单位 | unit_id | smallint | 6 | 是 | 辅助单位/采购单位 |
| 基本单位 | base_unit_id | smallint | 6 | 是 | 基本单位 |
| 创建时间 | created | datetime | 是 | 单据创建时间,格式:yyyy-MM-dd HH:mm:ss |
6.响应示例
6.1 正常响应示例
6.2 异常响应示例
| JSON | {
"code": "7201",
"message": "无效的外部采购单编号:CG201905180001"
} |