当前位置: API文档

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

¥标准

1.接口说明

1.1 接口描述:获取ERP各种业务类型的出库单及货品明细信息
1.2 适用版本:客户端 V2.4.1.7及以上版本
1.3 增量获取:按照ERP各业务类型出库单的最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。
1.4 时间跨度:start_time和end_time最大跨度为30天,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,建议根据获取数据量的多少适当减小时间跨度。

1.5 注意事项:

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

本接口销售出库单类型单据不返回淘系数据,相关平台规则单击这里。淘系敏感数据获取办法单击这里

2.调用场景

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

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://sandbox.wangdian.cn/openapi2/stockout_order_query.php
正式环境http://api.wangdian.cn/openapi2/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_timedata
按最后修改时间增量获取数据,start_time作为开始时间,格式:YYYY-MM-DD HH:MM:SS
结束时间end_timedata
按最后修改时间增量获取数据,end_time作为结束时间,格式:YYYY-MM-DD HH:MM:SS
分页大小page_sizeint10每页返回条数,输入值范围1~30,不传默认30,使用举例单击这里
页号page_noint10不传值默认从0页开始
出库单类型order_typetinyint11销售订单(包含现款销售订单),2调拨出库,3采购退货出库,4盘亏出库,5生产出库,7其他出库,8多发出库,9纠错出库,10保修配件出库,11初始化出库
出库单状态statustinyint1出库单状态5:已取消,50:待审核,55:已审核,95:已发货,110:已完成(默认查已发货已完成单据),113:异常发货
仓库编号warehouse_novarchar40代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置)(不支持一次推送多个仓库编号)
源单号src_order_novarchar40源单号

4.响应参数

   4.1 公共响应参数

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

   4.2 业务响应参数

   stockout_list

名称字段类型长度必须描述
出库单主键idstockout_idint11出库单主键id
出库单号order_novarchar40出库单号
源单号src_order_novarchar40源单号,上层单据的业务单号
仓库编号warehouse_novarchar40代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置),用于获取指定仓库数据信息
状态statusint4出库单状态
出库时间consign_timedate
出库时间,格式:YYYY-MM-DD HH:MM:SS
出库单类型order_typeint4出库单类型
出库单类型名称order_type_namevarchar40出库单类型名称
出库单子类型subtypevarchar256出库单子类型
出库原因stockout_reasonvarchar32出库原因
数量goods_countdecimal(19,4)货品数量
货品总销售金额goods_total_amountdecimal(19,4)货品总销售金额
货品总成本金额goods_total_costdecimal(19,4)货品总成本金额
邮费post_feedecimal(19,4)邮费
物流单号logistics_novarchar40物流单号(该出库单的运单号)
包装费package_feedecimal(19,4)包装费
收件人receiver_namevarchar40该字段已废弃
国家receiver_countrysmallint6国家
省份receiver_provinceint11省份
城市receiver_cityint11城市
地区receiver_districtint11地区
详细地址receiver_addressvarchar256该字段已废弃
收件人移动电话receiver_mobilevarchar40该字段已废弃
收件人固定电话receiver_telnovarchar40该字段已废弃
邮编receiver_zipvarchar20邮编
重量weightdecimal(19,4)重量
备注remarkvarchar255备注
外部单号outer_novarchar40外部单号
操作员姓名operator_namevarchar40操作员姓名
物流方式logistics_typesmallint6响应值为代表物流方式的数字,数字对应的物流方式名称单击这里
物流编号logistics_codevarchar20代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置)
物流公司名称logistics_namevarchar40erp对应的物流公司名称
Sku详情节点details_listdata
响应参数的2级数据节点,包含当出库单货品属性信息的数据节点,节点下数据字段详见下述" details_list"

   details_list

名称字段类型长度必须描述
出库单主键idstockout_idint11出库单主键id
出库单明细idrec_idint11出库单明细id
商家编码spec_novarchar40代表所单品(sku)所有属性的唯一编码,用于获取系统单品的数据,SKU概念介绍,单击这里
货品数量goods_countdecimal(19,4)货品数量
销售价sell_pricedecimal(19,4)销售价
品牌编号brand_novarchar32品牌编号
品牌名称brand_namevarchar64品牌名称
货品名称goods_namevarchar255货品名称
货品编号goods_novarchar40代表SPU所有属性的唯一编号,用于获取系统货品的数据,SPU概念介绍,单击这里
规格名称spec_namevarchar100规格名称
规格编号spec_codevarchar20规格编号
成本价cost_pricedecimal(19,4)成本价
总销售金额total_amountdecimal(19,4)总销售金额
重量weightdecimal(19,4)重量
备注remarkvarchar64备注
单位goods_unitvarchar20货品单位
批次号batch_novarchar20批次号

5.请求示例

PHP
<?php
    require_once ('../WdtClient.php');
    $c = new WdtClient();
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/stockout_order_query.php';
    
    $c->putApiParam('start_time', '2017-04-05 00:00:00');
    $c->putApiParam('end_time', '2017-04-05 23:59:59');
    $json = $c->wdtOpenApi();
    var_dump($json);
?>
JAVA
package com.wangdian.api.stock;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import com.wangdian.api.WdtClient;

public class StockoutOrderQuery {

    public static void main(String[] args) {
        // TODO Auto-generated method stub
        WdtClient client = new WdtClient("", "", "", "");
        Map<String, String> params = new HashMap<String, String>();
        params.put("start_time", "2018-12-01 00:00:00");
        params.put("end_time", "2018-12-10 00:00:00");
        try {
            String response = client.execute("stockout_order_query.php", params);
            System.out.println(response);
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

}
C#
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WdtSdk;

namespace StockoutOrderQuery
{
    class StockoutOrderQuery
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/stockout_order_query.php";

            client.putParams("start_time", "2017-04-05 00:00:00");
            client.putParams("end_time", "2017-04-05 23:59:59");
            client.putParams("order_type", "1");

            string result = client.wdtOpenapi();
            Console.WriteLine(result);
            Console.ReadKey();
        }
    }
}

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 0,
    "message": "succeed",
    "total_count": 1,
    "stockout_list": [{
        "stockout_id": "9259",
        "order_no": "CK2019051805",
        "src_order_no": "",
        "warehouse_no": "xyp2test",
        "consign_time": "2019-05-18 18:18:02",
        "status": "95",
        "order_type": "7",
        "goods_count": "1.0000",
        "goods_total_amount": "3699.0000",
        "goods_total_cost": "0.9900",
        "post_fee": "0.0000",
        "logistics_no": "",
        "package_fee": "0.0000",
        "receiver_name": "",
        "receiver_country": "0",
        "receiver_province": "0",
        "receiver_city": "0",
        "receiver_district": "0",
        "receiver_address": "",
        "receiver_mobile": "",
        "receiver_telno": "",
        "receiver_zip": "",
        "remark": "[接口创建出库单]",
        "weight": "0.0000",
        "stockout_reason": "",
        "subtype": "",
        "outer_no": "QTCK201905180001",
        "operator_name": "外部接口",
        "logistics_type": "0",
        "logistics_code": "",
        "logistics_name": "无",
        "order_type_name": "其他出库",
        "details_list": [{
            "rec_id": "17747",
            "stockout_id": "9259",
            "spec_no": "WDTPDA-BLACK006",
            "goods_count": "1.0000",
            "total_amount": "3699.0000",
            "sell_price": "3699.0000",
            "remark": "",
            "brand_no": "BD201811230002",
            "brand_name": "旺店通",
            "goods_name": "旺店通手持终端",
            "goods_no": "WDTPDA",
            "goods_unit": "",
            "batch_no": "",
            "spec_name": "旺店通手持终端黑色006型",
            "spec_code": "",
            "cost_price": "0.9900",
            "weight": "0.0000",
            "goods_type": "1"
        }]
    }]
}

   6.2 异常响应示例

JSON
{
    "code": "13",
    "message": "仓库不存在warehouse_no:333"
}



常用工具