当前位置: API文档

purchase_order_query.php(查询采购单管理)

¥标准

1.接口说明

1.1 接口描述:获取旺店通ERP各种业务类型的采购单信息
1.2 适用版本:250304迭代及之后
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_order_query.php
正式环境https://openapi.huice.com/openapi/purchase_order_query.php

   3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
是购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。
接口账号appkeyString
是本开放平台“自助对接”功能模块内自助申请,获取方式点击这里
时间戳timestampint
是北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。
签名signString
是API输入参数签名结果,签名算法介绍单击这里

   3.3 业务请求参数

名称字段类型长度必须描述
开始时间start_timedatetime
是按最后修改时间增量获取数据,start_time作为开始时间,格式:yyyy-MM-dd HH:mm:ss,注意时分秒无效
结束时间end_timedatetime
是按最后修改时间增量获取数据,end_time作为结束时间,格式:yyyy-MM-dd HH:mm:ss,注意时分秒无效
查询时间类型time_typeint
时间查询时必传1:创建时间, 2:修改时间
分页大小page_sizeint10否每页返回条数,输入值范围1~100,不传默认40,使用实例单击这里
页号page_noint10否不传值默认从0页开始
采购单状态statustinyint1否采购单状态5:待审核, 7:待财审, 10:已审核,11:待推送,12:推送失败,13:已推送,20:部分推送,30:已入库,99:已取消
仓库编号warehouse_novarchar40否代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置)(不支持一次推送多个仓库编号)
采购单号purchase_novarchar40否采购单号
外部单号 outer_novarchar40否ERP推送采购单外部返回单号(对应外部仓储单号) 
平台单号

platform_order_no

varchar40否传该字段可以不传开始时间和结束时间 (接口创建采购单推送的outer_no会作为客户端的平台单号)
标签名称label_listvarchar
否标签名称列表,JSON数组字符串,如 ["审核","入库"],传 "0"表示筛选无标签单据;标签筛选需和最后修改时间结合使用,不支持仅指定标签筛选



4.响应参数

   4.1 公共响应参数

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


4.2 业务响应参数

   purchase_list

名称字段类型长度必须描述
采购单id purchase_idbigint(20)
是采购单id,采购单表主键 
采购单号 purchase_novarchar40是ERP系统采购单编号 
外部单号 purchase_outer_no varchar40是ERP推送采购单外部返回单号(对应外部仓储单号)。
ERP客户端需升级至V2.3.8.6及以上版本可获取此字段
仓库名称warehouse_namevarchar64是仓库名称 
仓库编号warehouse_novarchar64是代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置)
预计到货时间expected_arrival_timedatetime
是预计到货时间
仓库IDwarehouse_idint11是仓库ID
已入库数量stocked_numdecimal(19,4)是已入库数量
其他费用other_feesdecimal(19,4)是其他费用
采购单状态 statustinyint4是5:待审核, 7:待财审,10:已审核,11:待推送,12:推送失败,13:已推送,20:部分推送,30:已入库,99:已取消
供应商名称 provider_namevarchar64是供应商名称 
采购员 purchaser_namevarchar20是采购员 
邮资 post_feedecimal(19,4)是邮资 
备注 remarkvarchar255是采购单备注 
最后修改时间 modifieddatetime
是单据的最后修改时间 
创建时间 createddatetime
是创建时间
创建人id creator_idint11是创建人id 
创建人姓名 creator_namevarchar40是创建人姓名
货品总价 goods_feedecimal(19,4) 是货品总价
货品数量 goods_countdecimal(19,4) 是货品数量
取消数量cancel_numint11是取消数量
供应商编码provider_novarchar40是供应商编码
供应商idprovider_idint11是供应商id
平台单号purchase_platform_order_novarchar40是平台单号
标签列表节点

labels

data[] 

采购单标签列表节点,节点下数据字段详见下述"labels"
采购单明细节点 details_listdata[] 40是响应参数的2级数据节点,,节点下数据字段详见下述“details_list” 

details_list

名称字段类型长度必须描述
主键 rec_idbigint(20)
是采购明细表主键id 
采购单id purchase_idbigint(20)
是采购单id 
商家编码spec_novarchar40是代表单品(sku)所有属性的编码
数量numdecimal(19,4) 是数量
单价 pricedecimal(19,4) 是单价 
备注remarkvarchar255是明细备注
供应商货号provider_goods_novarchar64是供应商货号
单品预计到货日期expected_arrival_timedatetime
是单品预计到货日期
采购单位unit_namevarchar20是采购单位
未入库数量un_stocked_numdecimal(19,4) 是未入库数量
已入库数量stocked_numdecimal(19,4) 是已入库数量
图片地址img_urlvarchar255是图片地址
主条码barcodevarchar50是主条码
创建时间create_datedatetime
是创建时间
修改时间modify_datedatetime
是修改时间
品牌名称brand_namevarchar64是品牌名称
单品自定义属性1sku_prop1varchar40是单品自定义属性1
单品自定义属性2sku_prop2varchar40是单品自定义属性2
单品自定义属性3sku_prop3varchar40是单品自定义属性3
单品自定义属性4sku_prop4varchar40是单品自定义属性4
单品自定义属性5sku_prop5varchar40是单品自定义属性5
单品自定义属性6sku_prop6varchar40是单品自定义属性6
折扣discountdecimal(19,4) 是折扣
税率tax_ratedecimal(19,4) 是税率
税前金额pre_tax_amountdecimal(19,4) 是税前金额
税前折后单价pre_tax_pricedecimal(19,4) 是税前折后单价
备注remarkvarchar255是明细备注
货品编号 goods_novarchar40是货品编号 
货品名称 goods_namevarchar255是货品名称 
规格名称 spec_namevarchar255是规格名称 
规格id spec_idbigint(20)
是规格id 
采购金额purchase_pricedecimal(19,4) 是采购价 
取消数量cancel_numdecimal(19,4) 是取消数量
供应商编码provider_novarchar40是供应商编码
供应商idprovider_idint11是供应商id
供应商名称provider_namevarchar40是供应商名称

labels

名称字段类型长度必须描述
标签IDidvarchar20是标签主键ID
标签名称purchase_idvarchar255是标签名称
业务类型business_type

tinyint

4是

标签业务类型,1:采购单

业务单据ID

order_id

varchar(19,4) 是

标签关联的业务单据ID

(采购单标签为空)

标签位掩码

label_mask

varchar(19,4) 是忽略,无实际含义



  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_order_query.php';
   
    $c->putApiParam('start_time', '2026-03-09 09:00:00');
    $c->putApiParam('end_time', '2026-03-09 10:00:00');
    $c->putApiParam('page_no', 0 );
    $c->putApiParam('page_size', 1 );

    $json = $c->wdtOpenApi();
    var_dump($json);
?>
JAVA
C#
python

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 200,
    "message": null,
    "total_count": 2,
    "purchase_list": [
        {
            "purchase_id": "2803943306390667268",
            "purchase_no": "CG2603090101",
            "provider_id": "0",
            "provider_name": "",
            "provider_no": "",
            "purchaser_name": "admin",
            "creator_id": "1976",
            "creator_name": "admin",
            "warehouse_no": "30",
            "warehouse_name": "北京自有仓库(测试0603)",
            "goods_fee": "0",
            "goods_count": "1",
            "cancel_num": "0",
            "remark": "",
            "status": 99,
            "created": "2026-03-09T09:49:39",
            "modified": "2026-03-10T09:18:06",
            "purchase_outer_no": "",
            "purchase_platform_order_no": "",
            "post_fee": "0",
            "details_list": [
                {
                    "rec_id": "2803943307317608452",
                    "purchase_id": "2803943306390667268",
                    "provider_id": "0",
                    "provider_name": "",
                    "provider_no": "",
                    "price": "0",
                    "num": "1",
                    "cancel_num": "0",
                    "remark": "",
                    "spec_id": "2803928459665998850",
                    "spec_name": "默认规格",
                    "spec_no": "2030808254194241537",
                    "goods_name": "活力开阳蕨麻饮品",
                    "goods_no": "2030808254194241537",
                    "purchase_price": "0"
                }
            ]
        }
    ]
}

   6.2 异常响应示例

JSON
{
    "code": 2900,
    "message": "必传参数缺失:start_time和end_time不能为空"
}





常用工具