当前位置: API文档

stockout_order_query_trade.php(查询销售出库单)

¥标准

1.接口说明

1.1 接口描述:获取ERP销售订单的出库单信息
1.2 适用版本:客户端 V2.4.1.3及以上版本

1.3 增量获取:

①照销售出库单的最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。

当不传status时,请求参数的开始时间和结束时间对应“发货时间”,返回已发货和已完成状态的出库单; 当传status的值大于等于95时,请求参数的开始时间和结束时间对应“发货时间”,返回status值对应的出库单;当传status的值小于95时,请求参数的开始时间和结束时间对应“修改时间(modified)”,返回出status值对应的出库单。
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、数据分析等系统的对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://sandbox.wangdian.cn/openapi2/stockout_order_query_trade.php
正式环境http://api.wangdian.cn/openapi2/stockout_order_query_trade.php

查询历史销售出库单地址:

环境HTTP地址
测试环境http://sandbox.wangdian.cn/openapi2/his_stockout_order_query_trade.php
正式环境http://api.wangdian.cn/openapi2/his_stockout_order_query_trade.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 业务请求参数

名称字段类型长度
必须描述
状态statustinyint45已取消,55已审核,95已发货,105 部分打款,110已完成,113:异常发货
开始时间start_timedate
增量获取数据,start_time作为开始时间,格式:YYYY-MM-DD HH:MM:SS
结束时间end_timedate
增量获取数据,end_time作为结束时间,格式:YYYY-MM-DD HH:MM:SS
系统订单编号
src_order_novarchar40

可以单独按照系统单号查询,不传其他参数
原始单号
src_tidvarchar40

可以单独按照原始单号查询,不传其他参数
出库单号
stockout_novarchar40

可以单独按照出库单号查询,不传其他参数
分页大小page_sizeint
每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为30,使用举例单击这里
页号page_noint
页号默认从0页开始
店铺编号shop_novarchar40代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),用于获取指定店铺单据数据信息
仓库编号warehouse_novarchar40代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置),用于获取指定仓库单据数据信息(不支持一次推送多个仓库编号)

4.响应参数

   4.1 公共响应参数

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

   4.2 业务响应参数

   stockout_list

名称字段类型长度
必须描述
出库单主键idstockout_idint11出库单主键id
出库单号order_novarchar40出库单号,唯一单号
源单号src_order_novarchar40源单号,旺店通系统单号(多默认为JY开头)
仓库编号warehouse_novarchar40仓库编号
发货时间consign_timedatetime时间销售出库单发货时间
出库单类型order_typetinyint4出库单类型
订单状态trade_statustinyint4订单状态 5已取消 10待付款 12待尾款 13待选仓 15等未付16延时审核 19预订单前处理 20前处理(赠品,合并,拆分)21委外前处理22抢单前处理 25预订单 27待抢单 30待客审 35待财审 40待递交仓库 45递交仓库中 50已递交仓库 53未确认 55已确认 95已发货 105部分打款 110已完成’
出库单类型名称order_type_namevarchar40固定名称“销售出库”
订单类型trade_typetinyint11网店销售 2线下零售 3售后换货 4批发业务 5保修换新 6保修完成 7订单补发 .. 101自定义类型1 102自定义类型2 103自定义类型3 104自定义类型4 105自定义类型5 106自定义类型6
出库子类型subtypevarchar256出库子类型
数量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_namevarchar
淘系平台不返回,其他平台正常返回
国家receiver_countrysmallint6国家
省份receiver_provincevarchar40省份
城市receiver_cityvarchar40城市
地区receiver_districtvarchar40地区
详细地址receiver_addressvarchar
淘系平台不返回,其他平台正常返回
收件人移动电话receiver_mobilevarchar
淘系平台不返回,其他平台正常返回
收件人固定电话receiver_telnovarchar
淘系平台不返回,其他平台正常返回
邮编receiver_zipvarchar40邮编
大头笔receiver_dtbvarchar128大头笔
实际重量weightdecimal(19,4)ERP系统称重功能记录的重量,如果没有使用称重功能默认使用货品档案维护的预估重量
物流公司类型logistics_typetinyint6响应值为ERP定义的ID数值,数值对应的物流公司类型名称单击这里
物流公司编号logistics_codevarchar60代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置)
物流公司名称logistics_namevarchar40物流公司名称
打印备注print_remarkvarchar255打印备注
已付金额paiddecimal(19,4)已付金额
退款状态refund_statustinyint4退款状态0无退款 1申请退款 2部分退款 3全部退款
业务员编号salesman_novarchar40业务员编号
业务员名称salesman_namevarchar40业务员名称
业务员名称fullnamevarchar40业务员名称
仓库warehouse_namevarchar40仓库
创建时间createddatetime时间创建时间
备注remarkvarchar255备注
出库原因stockout_reasonvarchar32出库原因
外部单号outer_novarchar40外部单号
订单编号trade_novarchar40系统订单编号,默认单号为JY开头,ERP内支持自定义(设置路径:设置——编码设置)
原始单号src_trade_novarchar255商城或电商平台的订单编号,合并订单的多个订单编号有逗号隔开
网名nick_namevarchar100淘系平台不返回,其他平台正常返回
客户名称customer_namevarchar
淘系平台不返回,其他平台正常返回(客户真实姓名,取自receiver_name)
客户编号customer_novarchar40客户编号
交易时间trade_timedatetime时间交易时间
付款时间pay_timedatetime时间付款时间
出库单状态statustinyint4出库单状态 5 已取消 55已审核 95 已发货 105部分打款 110已完成  113 异常发货
店铺名称shop_namevarchar128店铺名称
店铺编号shop_novarchar20代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置)
买家留言buyer_messagevarchar1024买家留言
客服备注cs_remarkvarchar1024客服备注
订单标记flag_namevarchar32订单标记
邮费post_amountdecimal(19,4)从平台获取的销售订单的邮费
截停原因block_reasonint11截停原因:1申请退款2已退款4地址被修改8发票被修改16物流被修改32仓库变化64备注修改128更换货品256取消退款
发票类别invoice_typetinyint4发票类别0 不需要,1普通发票,2普通增值税发票,3专用增值税发票
发票抬头invoice_titlevarchar255发票抬头
发票内容invoice_contentvarchar255发票内容
发票IDinvoice_idint11发票ID,目前只设0-1,1表示已开发票
发货条件delivery_termtinyint4发货条件 1款到发货 2货到付款(包含部分货到付款) 3分期付款 4挂账单
分销类别fenxiao_type
tinyint40 非分销订单 1 转供销 2 代销 3经销
分销商IDfenxiao_nick
varchar40分销订单的分销商id,或转供销时供应商id
货到付款金额cod_amountdecimal(19,4)货到付款金额
证件类别id_card_typetinyint11 身份证
收件人地址receiver_areavarchar128省市区空格分隔
店铺备注shop_remarkvarchar255店铺备注
最后修改时间modifieddatetime时间最后修改时间
平台idplatform_idtinyint4平台id
订单表主键trade_idint11订单表主键
审单员编号checker_namevarchar40审单员编号
审单员编号employee_novarchar40审单员编号
审核员operator_namevarchar40审核员
打包员编号packager_novarchar40打包员编号
打包员packager_namevarchar40打包员
拣货员编号picker_novarchar40拣货员编号
拣货员picker_namevarchar40拣货员
打单员编号printer_novarchar40打单员编号
打单员printer_namevarchar40打单员
验货员编号examiner_novarchar40验货员编号
验货员examiner_namevarchar40验货员
优惠金额discountdecimal(19,4)优惠金额
原始单号src_tidsvarchar255原始单号,平台订单号
税额taxdecimal(19,4)税额
税率tax_ratedecimal(19,4)税率
币种currencyvarchar20币种
证件号码id_cardvarchar40淘系平台不返回,其他平台正常返回
出库单审核时间stock_check_timedatetime时间出库单审核时间
异常状态bad_reasonint11需要通过异或的方式判断,异常订单(bit位),1无库存记录 2地址发生变化 4发票变化 8仓库变化16备注变化32平台更换货品64退款…512抢单异常
打印批次print_batch_novarchar20ERP中的单据的打印批次信息,如需该字段,请升级至2.4.0.8版本及以上
货品列表节点details_listdata[]
货品列表节点

   details_list

名称字段类型长度
必须描述
出库明细主键rec_idint11出库明细主键
出库单主键idstockout_idint11出库单主键id
商家编码spec_novarchar40代表单品(sku)所有属性的编码,SKU概念介绍,单击这里
货品数量goods_countdecimal(19,4)货品数量
销售价sell_pricedecimal(19,4)销售价,最终交易价格,扣除优惠
品牌编号brand_novarchar50品牌编号
品牌名称brand_namevarchar64品牌名称
货品类型goods_typetinyint1货品类型: 1销售商品 2原材料 3包装 4周转材料5虚拟商品6固定资产 0其它
是否是赠品gift_typetinyint1是否是赠品 0非赠品 1自动赠送 2手工赠送
货品名称goods_namevarchar255货品名称
货品编号goods_novarchar40代表货品(spu)所有属性的编号,SPU概念介绍,单击这里
规格名称spec_namevarchar100规格名称
规格码spec_codevarchar40规格码
来源组合装编码suite_novarchar40来源组合装编码
成本价cost_pricedecimal(19,4)成本价
总货款total_amountdecimal(19,4)总货款,sell_price * goods_count=total_amount
货品idgoods_idint11货品id
商品主键spec_idint11商品主键
估重weightdecimal(19,4)估重
备注remarkvarchar64备注
已支付金额paiddecimal(19,4)已支付金额
退款状态refund_statustinyint4退款状态
零售价market_pricedecimal(19,4)零售价
总折扣金额discountdecimal(19,4)总折扣金额
分摊后合计应收share_amountdecimal(19,4)分摊后合计应收
税率tax_ratedecimal(8,4)税率
条码barcodevarchar50条码
基本单位unit_namevarchar20基本单位
订单详情表主键sale_order_idint11订单详情表主键
邮费分摊share_postdecimal(19,4)邮费分摊
原始子订单号src_oidvarchar40原始子订单号
原始订单号src_tidvarchar40原始订单号
单据内部来源from_maskint111手机订单 2聚划算 4服务子订单 8家装 16二次付款 32开具电子发票 1024库存不足 2048当日达 4096次日达 8192预约时效
货品档案自定义属性1good_prop1varchar255货品档案自定义属性1
货品档案自定义属性2good_prop2varchar255货品档案自定义属性2
货品档案自定义属性3good_prop3varchar255货品档案自定义属性3
货品档案自定义属性4good_prop4varchar255货品档案自定义属性4
货品档案自定义属性5good_prop5varchar255货品档案自定义属性5
货品档案自定义属性6good_prop6varchar255货品档案自定义属性6
单品列表自定义属性1prop1varchar255单品列表自定义属性1
单品列表自定义属性2prop2varchar255单品列表自定义属性2
单品列表自定义属性3prop3varchar255单品列表自定义属性3
单品列表自定义属性4prop4varchar255单品列表自定义属性4
单品列表自定义属性5prop5varchar255单品列表自定义属性5
单品列表自定义属性6prop6varchar255单品列表自定义属性6
批次号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_trade.php';
    
    $c->putApiParam('status', 55);
    $c->putApiParam('start_time', '2017-04-01 00:00:00');
    $c->putApiParam('end_time', '2017-4-12 23:59:59');
    $c->putApiParam('page_no', '0');
    $c->putApiParam('page_size', '1');
    $json = $c->wdtOpenApi();
    var_dump($json);
?>
JAVA
package com.wangdian.api.trade;

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

import com.wangdian.api.WdtClient;

public class StockoutOrderQueryTrade {

    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("shop_no", "ghs2test");
        params.put("start_time", "2018-12-01 00:00:00");
        params.put("end_time", "2018-12-01 00:00:00");
        try {
            String response = client.execute("refund_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 StockoutOrderQueryTrade
{
    class StockoutOrderQueryTrade
    {
        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_trade.php";

            client.putParams("start_time", "2018-10-24 12:30:00");
            client.putParams("end_time", "2018-10-24 13:10:00");

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

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 0,
    "message": "succeed",
    "total_count": 1,
    "stockout_list": [{
        "stockout_id": "9255",
        "order_no": "CK2019051801",
        "src_order_no": "JY201905180001",
        "warehouse_no": "xyp2test",
        "consign_time": "2019-05-18 00:35:55",
        "status": "110",
        "order_type": "1",
        "goods_count": "2.0000",
        "goods_total_amount": "198.0000",
        "goods_total_cost": "0.0000",
        "post_fee": "0.0000",
        "logistics_no": "123456789011",
        "package_fee": "0.0000",
        "receiver_name": "小鹏",
        "receiver_country": "0",
        "receiver_province": "上海",
        "receiver_city": "上海市",
        "receiver_district": "虹口区",
        "receiver_address": "龙茗路9号",
        "receiver_mobile": "13456554333",
        "receiver_telno": "01000860086",
        "receiver_zip": "10089",
        "remark": "",
        "weight": "0.0000",
        "stockout_reason": "",
        "subtype": "",
        "outer_no": "",
        "operator_name": "admin",
        "logistics_type": "8",
        "logistics_code": "SF001",
        "logistics_name": "顺丰快递",
        "bad_reason": "0",
        "receiver_dtb": "上海市 虹口区",
        "print_remark": "",
        "paid": "198.0000",
        "refund_status": "0",
        "trade_type": "2",
        "salesman_no": "admin",
        "fullname": "admin",
        "salesman_name": "admin",
        "trade_status": "110",
        "warehouse_name": "小鹏测试仓库",
        "block_reason": "0",
        "print_batch_no": "",
        "trade_no": "JY201905180001",
        "src_trade_no": "115580935277840368-1",
        "nick_name": "ffasdasd",
        "customer_no": "KH201905170008",
        "customer_name": "h",
        "trade_time": "2019-05-18 00:25:17",
        "pay_time": "2019-05-18 00:25:17",
        "flag_name": "VIP",
        "post_amount": "0.0000",
        "id_card_type": "0",
        "id_card": "",
        "receiver_area": "上海 上海市 虹口区",
        "shop_name": "小鹏测试店铺",
        "shop_no": "xyp2test",
        "shop_remark": "勿更改本店铺内容",
        "modified": "2019-05-18 00:35:55",
        "buyer_message": "请发顺丰",
        "cs_remark": "发顺丰快递",
        "invoice_type": "0",
        "invoice_title": "",
        "invoice_content": "",
        "invoice_id": "0",
        "cod_amount": "0.0000",
        "delivery_term": "1",
        "fenxiao_type": "0",
        "fenxiao_nick": "",
        "platform_id": "0",
        "trade_id": "168498",
        "employee_no": "admin",
        "checker_name": "admin",
        "discount": "0.0000",
        "src_tids": "115580935277840368-1",
        "tax": "0.0000",
        "tax_rate": "0.0000",
        "currency": "",
        "created": "2019-05-18 00:30:59",
        "stock_check_time": "2019-05-18 00:34:22",
        "packager_no": "SYSTEM",
        "packager_name": "系统",
        "picker_no": "SYSTEM",
        "picker_name": "系统",
        "printer_no": "SYSTEM",
        "printer_name": "系统",
        "examiner_no": "SYSTEM",
        "examiner_name": "系统",
        "order_type_name": "销售订单",
        "receiver_province_code": "310000",
        "receiver_city_code": "310100",
        "receiver_district_code": "310109",
        "details_list": [{
            "rec_id": "17745",
            "stockout_id": "9255",
            "spec_no": "WDTPDA-BLACK006",
            "goods_count": "2.0000",
            "total_amount": "198.0000",
            "paid": "198.0000",
            "sell_price": "99.0000",
            "remark": "",
            "goods_name": "旺店通手持终端",
            "goods_no": "WDTPDA",
            "brand_no": "BD201811230002",
            "brand_name": "旺店通",
            "spec_name": "旺店通手持终端黑色006型",
            "spec_code": "BLACK006",
            "cost_price": "0.0000",
            "weight": "0.0000",
            "goods_id": "1",
            "spec_id": "1",
            "prop1": "",
            "prop2": "",
            "prop3": "",
            "prop4": "",
            "prop5": "",
            "prop6": "",
            "platform_id": "0",
            "refund_status": "0",
            "market_price": "99.0000",
            "discount": "0.0000",
            "share_amount": "198.0000",
            "tax_rate": "0.0000",
            "barcode": "WDTPDA-BLACK006",
            "unit_name": null,
            "sale_order_id": "294491",
            "share_post": "0.0000",
            "gift_type": "0",
            "src_oid": "AD201905180001",
            "src_tid": "115580935277840368-1",
            "from_mask": "131072",
            "goods_type": "1",
            "batch_no": "",
            "suite_no": "",
            "good_prop1": "",
            "good_prop2": "",
            "good_prop3": "",
            "good_prop4": "",
            "good_prop5": "",
            "good_prop6": ""
        }]
    }]
}

   6.2 异常响应示例

JSON
{
    "code": 2102,
    "message": "start_time和end_time为空或不是有效的时间格式[0000-00-00 00:00:00] "
}



常用工具