API文档

purchase_return_query.php（查询采购退货单）

¥标准

1.接口说明

1.1 接口描述：获取旺店通ERP各种业务类型的采购单信息

1.2 适用版本：网页版

1.3 时间跨度：开始时间和结束时间取值范围为闭区间取值，例如2018-11-01 00:00:00至2018-11-30 23:59:59，建议根据获取数据量的多少适当减小时间跨度

2.调用场景

2.1 SAP、线下ERP、SRM、SCM等系统对接

3.请求参数说明

3.1 请求地址

环境	HTTP地址
测试环境	https://openapi.ali.huice.cc/openapi/purchase_return_query.php
正式环境	https://openapi.huice.com/openapi/purchase_return_query.php

3.2 公共请求参数

名称	字段	类型	必须	描述
卖家账号	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输入参数签名结果，签名算法介绍单击这里

3.3 业务请求参数

名称	字段	类型	长度	必须	描述
开始时间	start_time	datetime		是	按最后修改时间增量获取数据,start_time作为开始时间, 格式：yyyy-MM-dd HH:mm:ss
结束时间	end_time	datetime		是	按最后修改时间增量获取数据,end_time作为结束时间, 格式：yyyy-MM-dd HH:mm:ss
分页大小	page_size	int	10	否	每页返回条数，输入值范围1~100，不传默认40，使用举例单击这里
页号	page_no	int	10	否	不传值默认从0页开始
查询时间类型	time_type	int	1	否	1：创建时间， 2：修改时间
状态	status	tinyint	1	否	采购单状态5：待审核，10：已审核，11：待推送，12：推送失败， 13：已推送，20：部分推送，30：已出库，99：已取消
仓库编号	warehouse_no	varchar	40	否	代表仓库所有属性的唯一编码，用于仓库区分，ERP内支持自定义（ERP仓库界面设置）(不支持一次推送多个仓库编号)
退货单号	return_no	varchar	40	否	按照退货单号查询不校验时间参数
外部单号	outer_no	varchar	40	否	外部单号
平台单号	platform_order_no	varchar	40	否	按照平台单号查询不校验时间参数(接口创建采购退货单推送的outer_no会作为客户端的平台单号)

4.响应参数

4.1 公共响应参数

名称	字段	类型	长度	必须	描述
错误码	code	int	11	是	状态码:200表示成功,其他表示失败
错误描述	message	varchar	255	是	错误描述
数据条数	total_count	int	10	否	符合条件的数据条数，用来分页当page_no = 0时返回
采购退货单数据节点	purchase_list	data[]		否	响应参数的1级数据节点，包含当前页的采购单及其明细的数据节点, 节点下数据字段详见下述" purchase_list"和“details_list”

4.2 业务响应参数

purchase_list

名称	字段	类型	长度	必须	描述
采购退货单id	return_id	int	11	是	采购退货单主键id
退货单号	return_no	varchar	40	是	退货单号
仓库	warehouse_name	varchar	64	是	仓库名称
仓库编号	warehouse_no	varchar	64	是	代表仓库所有属性的唯一编码，用于仓库区分， ERP内支持自定义（ERP仓库界面设置）
采购退货单状态	status	tinyint	4	是	5：待审核，10：已审核，11：待推送，12：推送失败， 13：已推送，20：部分推送，30：已出库，99：已取消
供应商名称	provider_name	varchar	64	是	供应商名称
供应商编码	provider_no	varchar	40	是	供应商编码
采购员名称	purchaser_name	varchar	20	是	采购员名称
采购员	purchaser_id	int	10	是	采购员id
备注	remark	varchar	255	是	采购单备注
最后修改时间	modified	datetime		是	单据的最后修改
创建时间	created	datetime		是	创建时间
制单员id	creator_id	int	11	是	制单员id
制单员姓名	creator_name	varchar	40	是	制单员姓名
供应商id	provider_id	int	11	是	供应商id
货品总价	goods_fee	decimal	(19,4)	是	货品总价
货品数量	goods_count	decimal	(19,4)	是	货品数量
取消数量	cancel_num	int	11	是	取消数量
平台单号	purchase_platform_order_no	varchar	40	是	平台单号
采购退货单货品列表节点	details_list	data[]	40	是	响应参数的2级数据节点，包含采购退货单货货品明细所有属性信息，节点下数据字段详见下述“detail_list”

details_list

名称	字段	类型	长度	必须	描述
主键	rec_id	int	11	是	采购明细表主键id
采购退货单id	return_id	int	11	是	采购退货单主键id
商家编码	spec_no	varchar	40	是	代表单品（sku）所有属性的编码
退货数量	num	decimal	(19,4)	是	退货数量
单价	price	decimal	(19,4)	是	单价
备注	remark	varchar	255	是	明细备注
货品编号	goods_no	varchar	40	是	货品编号
货品名称	goods_name	varchar	255	是	货品名称
规格名称	spec_name	varchar	255	是	规格名称
规格id	spec_id	int	11	是	规格id
退货金额	purchase_price	decimal	(19,4)	是	退货金额
取消数量	cancel_num	int	11	是	取消数量
供应商id	provider_id	int	11	是	供应商id
供应商编码	provider_no	varchar	40	是	供应商编码
供应商名称	provider_name	varchar	40	是	供应商名称

5.请求示例

PHP	<?php require_once '../WdtClient.php'; $c = new WdtClient(); $c->sid = ''; $c->appkey = ''; $c->appsecret = ''; $c->gatewayUrl = 'https://openapi.ali.huice.cc/openapi/purchase_return_query.php'; $c->putApiParam('page_no', 0); $c->putApiParam('page_size', 100); $c->putApiParam('return_no', 'CT2604030002'); $json = $c->wdtOpenApi(); var_dump($json); ?>
JAVA
C#
python

6.响应示例

6.1 正常响应示例

JSON

{
    "code": 200,
    "message": null,
    "total_count": 1,
    "purchase_list": [
        {
            "return_id": "2813006528200572931",
            "return_no": "CT2604030002",
            "provider_id": "1977902135890620418",
            "provider_name": "毛毛的店铺",
            "provider_no": "S0027",
            "purchaser_name": "",
            "creator_id": "-1",
            "creator_name": "openapi",
            "warehouse_no": "38",
            "warehouse_name": "滑雪场器材仓库1",
            "goods_fee": "0",
            "goods_count": "6",
            "cancel_num": "0",
            "remark": "备注",
            "status": 10,
            "created": "2026-04-03T10:03:39",
            "modified": "2026-04-03T10:03:39",
            "purchase_outer_no": "",
            "purchase_platform_order_no": "2026040300002",
            "details_list": [
                {
                    "rec_id": "2813006528246710275",
                    "return_id": "2813006528200572931",
                    "provider_id": "1977902135890620418",
                    "provider_name": "毛毛的店铺",
                    "provider_no": "S0027",
                    "price": "149.3097",
                    "num": "6",
                    "cancel_num": "0",
                    "remark": "采购货品明细备注",
                    "spec_id": "2750004503452319778",
                    "spec_name": "rm5555货品档案的规格铭恒",
                    "spec_no": "20251010-0085",
                    "goods_name": "这是货品档案的货品名称",
                    "goods_no": "20251010-007",
                    "purchase_price": "895.8582"
                }
            ]
        }
    ]
}

6.2 异常响应示例

JSON	{ "code": 2160, "message": "start_time和end_time为空或不是有效的时间格式" }