当前位置: API文档

stockout_order_query_return.php(查询采购退货出库单)

¥标准

1.接口说明

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

2.调用场景

2.1 财务系统、SAP、数据分析等系统的对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境https://sandbox.wangdian.cn/openapi2/stockout_order_query_return.php
正式环境https://api.wangdian.cn/openapi2/stockout_order_query_return.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
仓库编号warehouse_novarchar40代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置)
出库单状态statustinyint1出库单状态5:已取消,50:待审核,55:已审核,95:已发货,110:已完成(默认查已发货已完成单据)
页号page_noint10不传值默认从0页开始
分页大小page_sizeint10每页返回的数据条数,输入值范围1~30,不传本参数,输入值默认为30,使用举例单击这里
上层单据编号
src_order_novarchar40上层单据编号,默认为采购退货单号,传该字段可以不传开始时间和结束时间

4.响应参数

   4.1 公共响应参数

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

   4.2 业务响应参数

    stockout_list

传名称字段类型长度必须描述
出库单主键idstockout_idint11出库单主键id
出库单号order_novarchar40系统出库单号,默认为CK开头
源单号src_order_novarchar40该源单号为退货单号
仓库编号warehouse_novarchar40代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置)
状态statusint4出库状态
出库时间consign_timedatetime
出库时间,格式:yyyy-MM-dd HH:mm:ss
源单据类别order_typeint4源单据类别 1销售订单, 2调拨出库, 3采购退货出库, 4盘亏出库, 5生产出库, 6现款销售出库, 7其他出库, 8多发出库, 9纠错出库,10保修配件出库, 11初始化出库, 12jit拣货出库 13委外出库
源单据类型名称order_type_namevarchar40源单据类型名称
出库子类型subtypevarchar256出库子类型
货品数量goods_countdecimal(19,4)货品数量
货品总售价goods_total_amountdecimal(19,4)货品总售价
货品总成本goods_total_costdecimal(19,4)货品总成本
邮费post_feedecimal(19,4)邮费
物流编号logistics_novarchar40代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置)
包装费package_feedecimal(19,4)包装费
收件人receiver_namevarchar40该字段已废弃
国家receiver_countryint6国家
省份receiver_provinceint11省份
城市receiver_cityint11城市
地区receiver_districtint11地区
详细地址receiver_addressvarchar
该字段已废弃
收件人移动电话receiver_mobilevarchar
该字段已废弃
收件人固定电话receiver_telnovarchar
该字段已废弃
邮编receiver_zipvarchar20邮编
重量weightdecimal(19,4)重量
备注remarkvarchar60备注
出库原因stockout_reasonvarchar32出库原因
外部单号outer_novarchar40外部单号
操作人operator_namevarchar40操作人
省市区receiver_areavarchar255省市区空格分开
采购退货单号return_novarchar20采购退货单号
供应商编号provider_novarchar20代表供应商所有属性的唯一编码,用于供应商区分,ERP内支持自定义(ERP供应商界面设置)
供应商名称provider_namevarchar64供应商名称
出库单更新时间modifieddatetime
出库单的最后更新时间,格式:YYYY-MM-DD HH:MM:SS
采购退货单外部单号pr_api_outer_novarchar40采购退货单的外部单号
最后引用采购单号last_load_purchase_novarchar40最后引用采购单号
分拣单打印状态picklist_print_statustinyint4默认为'0',分拣单打印状态 0未打印 1打印中 2已打印 3无需打印
物流单打印状态logistics_print_statustinyint4默认为'0',物流单打印状态,0未打印 1打印中 2已打印 3无需打印
发货单打印状态sendbill_print_statustinyint4默认为'0',发货单打印状态,0未打印 1待打中 2已打印 3无需打印
出库单号stockout_novarchar40出库单号
源单据类别src_order_typetinyint4源单据类别 1销售订单, 2调拨出库, 3采购退货出库, 4盘亏出库, 5生产出库, 6现款销售出库, 7其他出库, 8多发出库, 9纠错出库,10保修配件出库, 11初始化出库, 12jit拣货出库 13委外出库'
源单据idsrc_order_idint11源单据id
处理状态wms_statusint4处理状态 0 待处理 1 推送失败 2 推送成功 3 接口取消成功系统驳回失败 4 服务器正在处理 5 WMS返回发货信息 6 异步标记,推送申请成功
错误信息error_infovarchar255接口处理错误信息
仓库类别warehouse_typetinyint4默认为'0',仓库类别  0不限 1普通仓库 2自动流转外部 3京东仓储 4科捷 5百世物流 6 SKU360 7通天晓 8中联网仓 9顺丰仓储 10网仓2号 11奇门仓储 12旺店通仓储 13心怡仓储 14力威仓储 15京东沧海 16云集仓储 127其他
出库的仓库idwarehouse_idsmallint
6出库的仓库id
客户idcustomer_idint11默认为'0',客户id
冻结原因freeze_reasonsmallint6默认为'0',冻结原因
是否分配is_allocatedtinyint1默认为'0',是否分配
出库状态consign_statusint11默认为'0',出库状态 1验货 2称重 4出库 8物流同步 16分拣 32档口, 64拣货
面单状态ebill_statustinyint4默认为'0',电子面单,获取状态
制单人operator_idint11默认为'0',制单人
制单人goods_type_countsmallint6默认为'0',货品种类数量
MD5字符串值md5_strvarchar40默认为'',MD5字符串值,用于单据排序
预留字段raw_goods_countdecimal(19,4)默认为'0',预留字段
出库类别custom_typesmallint6默认为'0',其他出库自定义子类别0,1,2,3,4
接收环receiver_ringvarchar20默认为'',京东三环内(未使用)
配送时间to_deliver_timevarchar20默认为'',配送时间
配送中心pre_charge_timevarchar20默认为'',配送中心
物流公司idlogistics_idsmallint6默认为'0',物流公司id
未知成本销售总额unknown_goods_amountdecimal(19,4)默认为'0.0000',未知成本销售总额
预估邮费成本calc_post_costdecimal(19,4)默认为'0.0000',预估邮费成本
邮费成本post_costdecimal(19,4)默认为'0.0000',邮费成本
预估重量calc_weightdecimal(19,4)默认为'0.0000',预估重量
快递给的重量post_weightdecimal(19,4)默认为'0.0000',快递给的重量
包装package_idint11默认为'0',包装
包装成本package_costdecimal(19,4)默认为'0.0000',包装成本
是否包含发票has_invoicetinyint1默认为'0',是否包含发票
打单员printer_idint11默认为'0',打单员
拣货出错次数pick_error_countint11默认为'0',拣货出错次数
拣货操作员idpicker_idint11默认为'0',拣货操作员id
包裹分拣员idsorter_idint11默认为'0',包裹分拣员id
验货操作员idexaminer_idint11默认为'0',验货操作员id
发货人idconsigner_idint11默认为'0',发货人id
打包员packager_idint11默认为'0',打包员
打包积分pack_scoreint11默认为'0',打包积分
拣货积分pick_scoreint11默认为'0',拣货积分
签出员工idcheckouter_idint11默认为'0',签出员工id
监视员watcher_idint11默认为'0',监视员
分拣单编号picklist_novarchar40默认为'',分拣单编号
分拣单中序号picklist_seqsmallint6默认为'0',订单在分拣单中序号
发票打印状态invoice_print_statustinyint4默认为'0',发票打印状态
颜色标记flag_idsmallint6默认为'0',颜色标记
物流单模板idlogistics_template_idsmallint6默认为'0', 物流单模板id
发货单模板idsendbill_template_idsmallint6默认为'0',发货单模板id
货位分配方式pos_allocate_modetinyint1默认为'0',货位分配方式:0系统自动分配, 1手动指定货位分配 2手动指定有效期批次货位
便签条数note_countsmallint6默认为'0',便签条数
出库原因reason_idint11默认为'0',其他出库原因
锁定策略idlock_idint11默认为'0',锁定策略id
保留reservevarchar40默认为'0',保留
截停原因block_reasonint11默认为'0',截停原因1申请退款2已退款4地址被修改8发票被修改16物流被修改32仓库变化64备注修改128更换货品256添加货品512放弃抢单1024其他原因2048拦截赠品4096拦截天猫换货8192买家留言变更16384货品平台规格名变更
打印批次batch_novarchar40默认为'',打印批次
出库单审核时间stock_check_timedatetime
出库单审核时间
货品列表节点
details_listdata
响应参数的2级数据节点,包含的采购退货出库单及其明细的数据节点,节点下数据字段详见下述details_list”列表

   detail_list

名称字段类型长度必须描述
出库明细主键idrec_idint11出库明细主键id
出库单主键idstockout_idint11出库单主键id
商家编码spec_novarchar40代表单品(SKU)所有属性的唯一编号,用于系统单品的区分,SKU概念介绍单击这里
货品数量goods_countdecimal(19,4)货品数量
销售价sell_pricedecimal(19,4)销售价
品牌编号brand_novarchar50品牌编号
品牌名称brand_namevarchar64品牌名称
货品名称goods_namevarchar255货品名称
货品编号goods_novarchar100代表SPU所有属性的唯一编号,用于系统货品的区分,SPU概念介绍单击这里
规格名称spec_namevarchar255规格名称
规格编号spec_codevarchar40规格编号
成本价cost_pricedecimal(19,4)成本价
总货款total_amountdecimal(19,4)总货款
重量weightdecimal(19,4)重量
货品类别goods_typeint11销售商品 2原材料 3包装 4周转材料5虚拟商品 0其它
单位名称goods_unitvarchar20单位名称
批次号batch_novarchar20批次号
批次备注batch_remarkvarchar255批次备注
有效期
expire_datedatetime
有效期,格式:yyyy-MM-dd HH:mm:ss
备注remarkvarchar255备注
货品idgoods_idint11货品id
规格idspec_idint11默认为'0',规格id
货位position_idint11默认为'0',货位,指出库货位
源单据类别src_order_typetinyint4默认为'1',源单据类别 1销售订单2,调拨出库3,采购出库4,生产出库5,盘亏出库6,其他出库
源单据细节idsrc_order_detail_idint11sales_trade_order表的主键
基本单位base_unit_idsmallint6默认为'0',基本单位
辅助单位unit_idsmallint6默认为'0',辅助单位
单位换算unit_ratiodecimal(19,4)默认为'1.0000',单位换算
辅助数量num2decimal(19,4)默认为'0.0000,辅助数量
货品数量numdecimal(19,4)货品数量
价格pricedecimal(19,4)默认为'0.0000,最终价格
出库批次batch_idint11默认为'0',指定出库批次
是否验货is_examinedtinyint1默认为'0',是否验货,用于挂起,已标记为验货的不需要再验货
是否包装is_packagetinyint1默认为'0',是否包装
是否允许0成本is_zero_costtinyint1默认为'0',是否允许0成本
类型scan_typetinyint1默认为'0',0未验货,1扫描验货,2手工验货
最后修改时间modifieddatetime
最后修改时间
创建时间createddatetime
创建时间
货位列表节点position_list
data[]

响应参数的3级数据节点,节点下数据字段详见下述position_list”列表

position_list

名称字段类型长度
必须描述
货位IDposition_idint11货位ID
货位编号position_novarchar
40
货位编号
货位出库数量
position_goods_countint11货位出库数量

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_return.php';
    
    $c->putApiParam('start_time', '2018-06-03 00:00:00');
    $c->putApiParam('end_time', '2018-06-21 20:13:41');
    $c->putApiParam('status', 40);
    $c->putApiParam('page_no', '0');
    $c->putApiParam('page_size', '10');
    $json = $c->wdtOpenApi();
    var_dump($json);
?>
JAVA
package com.wangdian.api.purchase;

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

import com.wangdian.api.WdtClient;

public class StockoutReturnOrderQuery {

    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-06 00:00:00");
        try {
            String response = client.execute("stockout_order_query_return.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 StockoutOrderQueryReturn
{
    class StockoutOrderQueryReturn
    {
        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_return.php";
            
            client.putParams("start_time", "2019-01-01 00:00:00");
            client.putParams("end_time", "2019-01-17 00:00:00");
            client.putParams("page_no", "0");
            client.putParams("page_size", "10");

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

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 0,
    "message": "succeed",
    "total_count": 1,
    "stockout_list": [{
        "stockout_id": "9258",
        "order_no": "CK2019051804",
        "src_order_no": "CR201905180002",
        "warehouse_no": "xyp2test",
        "consign_time": "2019-05-18 17:52:41",
        "status": "110",
        "order_type": "3",
        "goods_count": "1.0000",
        "goods_total_amount": "3699.0000",
        "goods_total_cost": "0.9900",
        "post_fee": "3699.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": "OPCG201905180001-1",
        "operator_name": "外部接口",
        "receiver_area": "",
        "return_no": "CR201905180002",
        "provider_no": "001",
        "provider_name": "旺店通PDA供应商",
        "pr_api_outer_no": "OPCG201905180001-1",
        "last_load_purchase_no": "",
        "modified": "2019-05-18 17:52:41",
        "order_type_name": "采购退货出库",
        "details_list": [{
            "rec_id": "17746",
            "stockout_id": "9258",
            "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": "BLACK006",
            "cost_price": "0.9900",
            "weight": "0.0000",
            "goods_type": "1"
        }]
    }]
}

   6.2 异常响应示例

JSON
{
    "code": 2104,
    "message": "start_time与end_time时间跨度不能超过最大范围 30天"
}



常用工具