当前位置: API文档
purchase_return_query.php(查询采购退货单)
1.1 接口描述:批量获取旺店通ERP的采购退货单及明细信息 |
1.2 适用版本:客户端 V2.6.0.8及以上版本 |
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_return_query.php |
正式环境 | https://api.wangdian.cn/openapi2/purchase_return_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输入参数签名结果,签名算法介绍单击这里 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
状态 | status | tinyint | 否 | 采购退货单状态:10,已取消,20,编辑中,30,待审核,40,已审核,42,待推送,44,推送失败,46,委外待出库,50,部分出库,60,已完成 | |
开始时间 | 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仓库界面设置) |
退货单号 | return_no | varchar | 40 | 否 | 按照退货单号查询不校验时间参数 |
分页大小 | page_size | int | 10 | 否 | 每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40,使用举例单击这里 |
页号 | page_no | int | 10 | 否 | 不传值默认从0页开始 |
外部API单号 | api_outer_no | varchar | 40 | 否 | 外部系统采购退货单的唯一单据编号,传该字段可以不传开始时间和结束时间(创建采购退货单时所传outer_no字段) |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 11 | 是 | 错误码,0成功 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
符合条件的数据条数 | total_count | int | 11 | 是 | 符合条件的数据条数,用来分页 当page_no=0时返回 |
采购退货单数据节点 | purchase_list | data[ ] | 是 | 响应参数的1级数据节点,包含当前页的采购单及其明细的数据节点,节点下数据字段详见下述" purchase_list"和“details_list” |
purchase_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
采购退货单id | return_id | int | 11 | 是 | 采购退货单主键id |
退货单号 | return_no | varchar | 40 | 是 | 退货单号 |
供应商 | provider_name | varchar | 64 | 是 | 供应商 |
采购单状态 | status | tinyint | 4 | 是 | 采购退货单状态:10,已取消,20,编辑中,30,待审核,40,已审核,42,待推送,44,推送失败,46,委外待出库,50,部分出库,60,已完成 |
仓库编号 | warehouse_no | varchar | 40 | 是 | 代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置) |
仓库 | warehouse_name | varchar | 64 | 是 | 系统仓库名称 |
采购员id | purchaser_id | int | 10 | 是 | 采购员id |
采购员名称 | purchaser_name | varchar | 20 | 是 | 采购员名称 |
物流类型 | logistics_type | smallint | 6 | 是 | 物流方式,详情介绍,单击这里 |
其它费用 | other_fee | decimal | (19,4) | 是 | 其它费用 |
邮费 | post_fee | decimal | (19,4) | 是 | 邮费 |
总货款 | goods_fee | decimal | (19,4) | 是 | 总货款 |
退货开单量 | goods_count | decimal | (19,4) | 是 | 退货开单量 |
货品种类数 | goods_type_count | int | 11 | 是 | 货品种类数 |
退货出库量 | goods_out_count | decimal | (19,4) | 是 | 退货出库量 |
备注 | remark | varchar | 255 | 是 | 采购退货单备注 |
建单时间 | created | datetime | 是 | 格式:yyyy-MM-dd HH:mm:ss | |
最后修改时间 | modified | datetime | 是 | 格式:yyyy-MM-dd HH:mm:ss | |
外部接口单号 | api_outer_no | varchar | 40 | 是 | 外部接口单号 |
外部单号 | outer_no | varchar | 40 | 是 | 外部单号 |
自定义属性1 | prop1 | varchar | 255 | 是 | 自定义属性1 |
自定义属性2 | prop2 | varchar | 255 | 是 | 自定义属性2 |
供应商编号 | provider_no | varchar | 40 | 是 | 供应商编号 |
引用采购单号 | purchase_no | varchar | 40 | 是 | 引用采购单号 |
制单员id | creator_id | int | 11 | 是 | 制单员id |
制单员姓名 | creator_name | varchar | 11 | 是 | 制单员姓名 |
类型 | type | tinyint | 4 | 是 | 默认为'1',1退货 |
颜色标记 | flag_id | int | 11 | 是 | 默认为'0',颜色标记 |
出库id | warehouse_id | varchar | 255 | 是 | 出库id |
供应商id | provider_id | int | 11 | 是 | 默认为'0',供应商id |
联系人姓名 | contact | varchar | 40 | 是 | 供商商联系人姓名 |
联系电话 | telno | varchar | 32 | 是 | 供应商联系电话 |
退货地址 | receive_address | varchar | 255 | 是 | 退货地址 |
审核人 | check_operator_id | int | 11 | 是 | 默认为'0',审核人 |
审核时间 | check_time | datetime | 是 | 默认'0000-00-00 00:00:00',审核时间 | |
便签条数 | note_count | smallint | 6 | 是 | 默认为'0',便签条数 |
省份 | province | varchar | 50 | 是 | 默认为'',省份 |
城市 | city | varchar | 50 | 是 | 默认为'',城市 |
地区 | district | varchar | 50 | 是 | 默认为'',地区 |
外部仓库的单号 | wms_outer_no | varchar | 40 | 是 | 默认为'',对应外部仓库的单号 |
处理状态 | wms_status | int | 4 | 是 | 默认为'0',处理状态 |
错误信息 | error_info | varchar | 255 | 是 | 默认为'',接口调用错误信息 |
版本号 | version_id | int | 11 | 是 | 默认为'0',版本号 |
最后一次引用的采购单id | last_load_purchase_id | int | 11 | 是 | 默认为'0',最后一次引用的采购单id |
审核员名称 | check_operator_name | varchar | 40 | 是 | 审核员名称 |
采购退货单货品列表节点 | detail_list | data[ ] | 是 | 响应参数的2级数据节点,包含采购退货单货货品明细所有属性信息,节点下数据字段详见下述“detail_list” | |
退货物流列表节点 | logistics_detail_list | data[ ] | 是 | 响应参数的2级数据节点,包含退货物流的所有属性信息,节点下数据字段详见下述“logistics_detail_list” |
detail_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
采购退货单id | return_id | int | 11 | 是 | 采购退货单主键id |
供应商货品编号 | provider_goods_no | varchar | 64 | 是 | 供应商货品编号 |
商家编码 | spec_no | varchar | 40 | 是 | 代表单品(sku)所有属性的编码,SKU概念介绍,单击这里 |
货品编码 | goods_no | varchar | 40 | 是 | 代表货品(spu)所有属性的编号,SPU概念介绍,单击这里 |
货品名称 | goods_name | varchar | 255 | 是 | 货品名称 |
规格名称 | spec_name | varchar | 100 | 是 | 规格名称 |
规格码 | spec_code | varchar | 40 | 是 | 规格码 |
退货数量 | num | decimal | (19,4) | 是 | 退货数量 |
辅助退货量 | num2 | decimal | (19,4) | 是 | 辅助退货量 |
出库单位 | unit_id | int | 11 | 是 | 出库单位 |
单位变换率 | unit_ratio | decimal | (19,4) | 是 | 单位变换率 |
基本单位 | base_unit_id | int | 11 | 是 | 基本单位 |
单价 | price | decimal | (19,4) | 是 | 单价 |
折扣 | discount | decimal | (19,4) | 是 | 折扣 |
税前金额 | amount | decimal | (19,4) | 是 | 税前金额 |
出库单位名称 | unit_name | varchar | 20 | 是 | 出库单位名称 |
基本单位名称 | base_unit_name | varchar | 20 | 是 | 基本单位名称 |
备注 | remark | varchar | 255 | 是 | 货品明细备注 |
税率 | tax | decimal | (19,4) | 是 | 默认为'0.0000',税率 |
税后金额 | tax_amount | decimal | (19,4) | 是 | 默认为'0.0000',税后金额 |
明细id | rec_id | int | 11 | 是 | 明细id,自动增量 |
规格id | spec_id | int | 11 | 是 | 规格id |
退货出库数量 | out_num | decimal | (19,4) | 是 | 默认为'0.0000',退货出库数量,库存单位 |
退货出库金额 | out_amount | decimal | (19,4) | 是 | 默认为'0.0000',退货出库总金额 |
税后单价 | tax_price | decimal | (19,4) | 是 | 默认为'0.0000',税后单价 |
最后修改时间 | modified | datetime | 是 | 最后修改时间 | |
创建时间 | created | datetime | 是 | 创建时间 | |
品牌 | brand_name | varchar | 64 | 是 | 品牌名称 |
logistics_detail_list
6.响应示例
6.1 正常响应示例
6.2 异常响应示例
JSON | { "code": 2102, "message": "start_time和end_time为空或不是有效的时间格式[0000-00-00 00:00:00] " } |