当前位置: API文档

stockout_order_query.php(查询出库单管理)

¥标准   

1.接口说明

1.1 接口描述:获取旺店通ERP的各种业务类型的出库单就其明细信息
1.2 适用版本:网页版

1.3 增量获取:如果状态(status)未传值或者值大于等于95时按照出库时间增量获取数据,如果状态(status)小于95时按照最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。

1.4 时间跨度:start_time和end_time最大跨度为30天,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,

建议根据获取数据量的多少适当减小时间跨度。

1.3注意事项:

⑴获取的各业务类型的出库单信息,不包含上层单据内容。(举例:调拨出库单的上层单据是调拨单,本接口能获取调拨出库单信息,不能查调拨单信息)

⑵本接口销售出库单类型单据不进行返回,获取销售出库单类型的数据需调用查询销售出库单接口。

2.调用场景

2.1 举例说明:SAP、线下ERP、SRM、SCM等系统对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境https://openapi.ali.huice.cc/openapi/stockout_order_query.php
正式环境https://openapi.huice.com/openapi/stockout_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

分页大小page_sizeint10每页返回条数,输入值范围1~100,不传默认40,使用举例单击这里
页号page_noint10不传值默认从0页开始
出库单类型order_typetinyint1

2调拨出库,3采购退货出库,4盘亏出库,5生产出库,7其他出库,8多发出库

,9纠错出库,10保修配件出库,11初始化出库,12jit拣货出库,13委外出库

出库单状态statustinyint1

出库单状态
20,待审核
25, 已审核
30, 已出库
40,已取消

仓库编号warehouse_novarchar40

代表仓库所有属性的唯一编码,客户端仓库信息维护界面:仓库id

源单号src_order_novarchar40源单号
出库单号stockout_novarchar40出库单号,传该字段可以不传时间
外部API单号outer_novarcher40

外部系统出库单的唯一单据编号,传该字段可以不传开始时间和结束时

间(创建出库单时所传outer_no字段)

4.响应参数

   4.1 公共响应参数

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

   4.2 业务响应参数

   stockout_list

名称字段类型长度必须描述
出库单主键ididint11出库单主键id
出库单号stockout_novarchar40出库单号
源单号src_order_novarchar40源单号,上层单据的业务单号
仓库编号warehouse_idvarchar40

代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定

义(ERP仓库界面设置),用于获取指定仓库数据信息

状态consign_statusint4

出库单状态
20, 待审核
25,  已审核
30, 已出库
40,  已取消

出库时间consign_timedate
出库时间,格式:yyyy-MM-dd HH:mm:ss
出库单类型src_order_typeint4

出库单类型,2调拨出库,3采购退货出库,4盘亏出库,

5生产出库,7其他出库,8多发出库,9纠错出库,10保修配件出库,

11初始化出库,12jit拣货出库,13委外出库

出库单类型名称src_order_type_namevarchar40出库单类型名称
出库单子类型src_order_sub_typevarchar256出库单子类型
出库原因stockout_reasonvarchar32出库原因
数量goods_countdecimal(19,4)货品数量
货品总销售金额goods_total_amountdecimal(19,4)货品总销售金额
物流单号logistics_novarchar40物流单号(该出库单的运单号)
收件人receiver_namevarchar40该字段已废弃
国家receiver_countrysmallint6国家
省份receiver_provincevarchar40省份
城市receiver_cityvarchar40城市
地区receiver_districtvarchar60地区
详细地址receiver_addressvarchar256该字段已废弃
收件人移动电话receiver_mobilevarchar40该字段已废弃
收件人固定电话receiver_telnovarchar40该字段已废弃
邮编receiver_zipvarchar20邮编
重量weightdecimal(19,4)重量
备注remarkvarchar255备注
外部单号outer_novarchar40外部单号
操作员姓名create_byvarchar40操作员姓名
物流方式logistics_typesmallint6

响应值为代表物流方式的数字

,数字对应的物流方式名称单击这里

物流编号logistics_codevarchar20

代表物流所有属性的唯一编码,用于物流区分

,ERP内支持自定义(ERP物流界面设置)

物流公司名称logistics_namevarchar40erp对应的物流公司名称
最后修改时间modify_datedatetime
单据最后修改时间,格式:yyyy-MM-dd HH:mm:ss
创建时间create_datedatetime
单据创建时间,格式:yyyy-MM-dd HH:mm:ss
Sku详情节点order_detail_listdata[]

响应参数的2级数据节点,包含当出库单货品属性信息的数据节点

,节点下数据字段详见下述" details_list"


order_detail_list

名称字段类型长度必须描述
出库单主键idstockout_idint11出库单主键id
出库单明细ididint11出库单明细id
上层单据明细主键src_order_detail_idint11上层单据明细主键
商家编码sku_novarchar40

代表所单品(sku)所有属性的唯一编码,用于获取系统单品的数据

,SKU概念介绍,单击这里

货品数量numdecimal(19,4)货品数量
销售价stockout_pricedecimal(19,4)销售价
货品名称spu_namevarchar255货品名称
货品编号spu_novarchar40

代表SPU所有属性的唯一编号,用于获取系统货品的数据

,SPU概念介绍,单击这里

规格名称sku_namevarchar100规格名称
成本价cost_pricedecimal(19,4)成本价
总销售金额stockout_amountdecimal(19,4)总销售金额
重量weightdecimal(19,4)重量
备注remarkvarchar64备注
批次号batch_novarchar20批次号
有效期expire_datedatetime

有效期,格式:yyyy-MM-dd HH:mm:ss
商品类型stock_typetinyint4

1: 正品 | 2: 次品

供应商idprovider_idint11

供应商id      仅当order_type=3时,返回该字段

供应商编码provider_novarchar64供应商编码    仅当order_type=3时,返回该字段
供应商名称provider_namevarchar64供应商名称    仅当order_type=3时,返回该字段

5.请求示例

PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = "";
    $c->gatewayUrl = 'https://openapi.ali.huice.cc/openapi/stockout_order_query.php';
     
    $c->putApiParam('start_time', '2026-01-24 15:01:27');
    $c->putApiParam('end_time', '2026-01-28 15:10:27');
    $c->putApiParam('page_no', 0);
    $c->putApiParam('page_size', 1);
	
    $json = $c->wdtOpenApi();
    var_dump($json);
?>
JAVA
C#
python

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 0,
    "message": "",
    "total_count": 3,
    "stockout_list": [
        {
            "order_detail_list": [
                {
                    "prop1": null,
                    "prop2": null,
                    "prop3": null,
                    "prop4": null,
                    "prop5": null,
                    "prop6": null,
                    "prop7": null,
                    "prop8": null,
                    "prop9": null,
                    "prop10": null,
                    "sku_id": "2786271737598181394",
                    "warehouse_id": null,
                    "sku_sort_name": null,
                    "sku_no": "125001",
                    "sku_name": "\u9177\u5f00-TV-50C60",
                    "sku_short_name": "",
                    "barcode": "260119303",
                    "spu_id": "2786271737501712402",
                    "spu_name": "\u9177\u5f00-TV-50C60",
                    "spu_short_name": "\u9177\u5f00-TV-50C60",
                    "spu_no": "125001",
                    "spu_modify_date": "2026-01-21T15:18:06",
                    "plat_spu_no": "",
                    "plat_sku_no": "",
                    "image_url": "",
                    "spu_img_url": "",
                    "outer_sku_no": "",
                    "ref_cost_price": "0",
                    "price": "0",
                    "retail_price": "0",
                    "wholesale_price": "0",
                    "validity_days": null,
                    "unit_id": "0",
                    "unit_name": null,
                    "weight": "0",
                    "box_sku_num": 0,
                    "sku_remark": null,
                    "sku_delete_flag": false,
                    "brand_id": "2786271559587726354",
                    "brand_name": "\u5176\u4ed6",
                    "goods_category_id": "0",
                    "approval_number": "",
                    "stock_num": null,
                    "quality_num": null,
                    "defect_num": null,
                    "default_position_name": null,
                    "location_name": null,
                    "location_id": null,
                    "stock_type": 1,
                    "stock_type_text": null,
                    "batch_id": "0",
                    "batch_no": "",
                    "production_date": null,
                    "expire_date": null,
                    "sku_position_vo_list": null,
                    "id": "2789505483059232787",
                    "stockout_id": "2789505483055038483",
                    "src_order_detail_id": "2789504267856117779",
                    "base_unit_id": "0",
                    "base_unit_name": null,
                    "unit_ratio": "0",
                    "num": "30",
                    "plan_num": "30",
                    "actual_num": null,
                    "auxiliary_num": "0",
                    "stockout_amount": "0",
                    "stockout_price": "0",
                    "total_amount": "0",
                    "cost_price": "0",
                    "sku_code": "",
                    "img_url": "",
                    "owner_id": "",
                    "remark": "",
                    "sn_num": null,
                    "goods_labels": null
                }
            ],
            "detail_list": null,
            "id": "2789505483055038483",
            "stockout_no": "CKQ2601280002",
            "outer_no": "",
            "src_order_type": 3,
            "src_order_no": "CT2601280101",
            "src_order_id": "2789504267487019027",
            "src_order_type_name": "\u91c7\u8d2d\u9000\u8d27\u51fa\u5e93",
            "src_order_sub_type": "0",
            "src_order_sub_type_name": null,
            "warehouse_type": 0,
            "warehouse_id": "4",
            "warehouse_name": null,
            "stockout_reason": "0",
            "stockout_reason_name": null,
            "consign_status": 30,
            "consign_status_name": "\u5df2\u51fa\u5e93",
            "logistics_id": "0",
            "logistics_name": "",
            "logistics_code": "",
            "logistics_type": "",
            "logistics_no": "",
            "post_amount": null,
            "goods_count": "30",
            "quality_goods_count": "30",
            "actual_goods_count": null,
            "goods_type_count": 1,
            "goods_total_amount": null,
            "total_stockout_amount": "0",
            "receiver_name": "",
            "receiver_country": null,
            "receiver_province": 0,
            "receiver_city": 0,
            "receiver_district": 0,
            "receiver_address": "",
            "receiver_mobile": "",
            "receiver_telno": null,
            "receiver_zip": null,
            "receiver_area": null,
            "remark": "",
            "create_by": "4307",
            "creator_name": null,
            "create_date": "2026-01-28T13:38:54",
            "modify_date": "2026-01-28T13:38:54",
            "consign_time": "2026-01-28T13:38:54"
        }
    ]
}

   6.2 异常响应示例

JSON
{
    "code": 11000000,
    "message": "时间查询范围不能超过30天,请缩小搜索范围!"
}





常用工具