当前位置: API文档

stockin_order_query_refund.php(查询退货入库单)

¥标准

1.接口说明

1.1 接口描述:获取ERP销售退货(换货)订单对应的入库单信息
1.2 适用版本:客户端 V2.4.2.3及以上版本
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、数据分析等系统的对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://sandbox.wangdian.cn/openapi2/stockin_order_query_refund.php
正式环境http://api.wangdian.cn/openapi2/stockin_order_query_refund.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~50,不传本参数,输入值默认为30,使用举例单击这里
页号page_noint10不传值默认从0页开始
入库单状态statustinyint4入库单状态 10已取消20编辑中30待审核60待结算80已完成(默认查询80已完成单据)
店铺编号shop_novarchar40代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),用于获取指定店铺数据信息
入库单号
stockin_novarchar40入库单号,传该字段可以不传时间范围
退换单号
src_order_novarchar40系统退换单号,默认TK开头,传该字段可以不传时间范围

4.响应参数

   4.1 公共响应参数

名称字段类型长度必须描述
错误码codeint40状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
数据条数total_countint10符合条件的数据条数,用来分页 当page_no = 0时返回
入库单详情stockin_listdata[]
入库单详情数据节点

   4.2 业务响应参数

   stockin_list

名称字段类型长度必须描述
入库单主键idstockin_idint11入库单主键id
入库单号order_novarchar40入库单号
仓库编号warehouse_novarchar40代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置)
仓库名称warehouse_namevarchar64仓库名称
店铺编号shop_novarchar20代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),用于获取指定店铺数据信息
店铺备注shop_remarkvarchar255店铺备注
上层单据(退换单)编号src_order_novarchar
40
上层单据(退换单)编号,默认TK开头
退换单状态process_statustinyint410已取消,20待审核,30已同意,40已拒绝,50待财审,60待收货,63待推送,64推送失败,65委外待收货,69待收货(已结算),70部分到货,71部分到货(已结算),80待结算 ,90已完成。ERP版本V2.3.8.4及以上才可返回
退货入库单状态statustinyint4入库单状态 10已取消20编辑中30待审核60待结算80已完成
更新时间stockin_timedatedatetime更新时间
创建时间created_timedatedatetime创建时间
备注remarkvarchar255备注
订单编号trade_novarchar40系统订单编号,默认单号为JY开头,ERP内支持自定义(设置路径:设置——编码设置)
系统订单类别trade_typevarchar128系统订单类别(1网店销售,2线下零售,3售后换货,4批发业务,5保修换新,6保修完成,7订单补发 .. 101自定义类型1,102自定义类型2,103自定义类型3,104自定义类型4 ,105自定义类型5,106自定义类型6)
单据类别order_typetinyint4单据类别,默认返回3
单据类别名称
order_type_namevarchar
128单据类别名称,默认为“退货入库”
货品数量goods_countdecimal(19,4)货品数量
货款总额goods_amountdecimal(19,4)退回货款收入
实际退款金额actual_refund_amountdecimal(19,4)实际退款金额
扣除优惠后货款总额total_pricedecimal(19,4)退回货品成本
优惠金额discountdecimal(19,4)优惠金额
税后金额tax_amountdecimal(19,4)税后金额
邮费post_feedecimal(19,4)退货入库单的“邮资”
其他费用other_feedecimal(19,4)退货入库单的“其它金额”
纠错金额adjust_pricedecimal(19,4)纠错金额
调整后总金额right_pricedecimal(19,4)调整后总金额
物流类型logistics_typesmallint6响应值为代表物流类型的数字,数字对应的物流类型名称单击这里
物流编号logistics_novarchar20代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置)
物流名称logistics_namevarchar40ERP设置的物流公司名称
物流单号logistics_codevarchar40物流单单号
退换单编号refund_novarchar40退换单编号
入库审核时间check_timedatetime
返回数据格式,0000-00-00 00:00:00
客户编号customer_novarchar40客户编号
客户名称customer_namevarchar40退货人的姓名
客户网名nick_namevarchar100客户网名
店铺名称shop_namevarchar128店铺名称
退换原因stockin_reasonvarchar32退换原因
退货单标记flag_namevarchar32退换单界面的标记
平台idplatform_idtinyint4平台id
订单原始单号
tid
varchar
40
订单原始单号
货品列表节点details_listdatadata退回货品列表节点

details_list

名称字段类型长度必须描述
明细表主键idrec_idint11明细表主键id
入库单主键idstockin_idint11入库单主键id
上层单据(退换单)退回货品明细主键src_order_detail_idint11上层单据(退换单)退回货品明细主键,ERP版本V2.3.8.3及以上才可返回
商家编码spec_novarchar40代表单品(sku)所有属性的唯一编码,用于系统单品区分,SKU概念介绍,单击这里
货品数量goods_countdecimal(19,4)货品数量
优惠金额discountdecimal(19,4)优惠金额
成本价cost_pricedecimal(19,4)成本价
生产日期production_datedatetime

生产日期,格式:YYYY-MM-DD HH:MM:SS
有效期天数validity_daysint
11
有效期天数
有效期expire_datedatetime

有效期,格式:YYYY-MM-DD HH:MM:SS
原价src_pricedecimal(19,4)原价
税后单价tax_pricedecimal(19,4)税后单价
税后金额tax_amountdecimal(19,4)税后金额
税率taxdecimal(19,4)税率
总成本total_costdecimal(19,4)总成本
备注remarkvarchar255备注
纠错数量adjust_numdecimal(19,4)纠错数量
纠错金额adjust_pricedecimal(19,4)纠错金额
调整后数量right_numdecimal(19,4)调整后数量
调整后单价right_pricedecimal(19,4)调整后单价
调整后总金额right_costdecimal(19,4)调整后总金额
品牌编号brand_novarchar32品牌编号
品牌名称brand_namevarchar64品牌名称
货品名称goods_namevarchar255货品名称
单品自定义属性2prop2varchar255单品自定义属性2
货品编号goods_novarchar40代表货品(spu)所有属性的唯一编号,用于系统货品区分,,SPU概念介绍,单击这里
规格名称spec_namevarchar255规格名称
规格编号spec_codevarchar40规格编号
基本单位goods_unitvarchar20基本单位
入库批次batch_novarchar20入库批次

5.请求示例

PHP
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WdtSdk;

namespace RefundQuery
{
    class RefundQuery
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/refund_query.php";
            
            client.putParams("start_time", "2019-01-01 00:00:00");
            client.putParams("end_time", "2019-01-17 00:00:00");

            string result = client.wdtOpenapi();
            Console.WriteLine(result);
            Console.ReadKey();
        }
    }
}
JAVA
package com.wangdian.api.refund;

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

import com.wangdian.api.WdtClient;

public class StockinRefundQuery {

    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-04 00:00:00");
        params.put("end_time", "2018-12-11 00:00:00");
        try {
            String response = client.execute("stockin_order_query_refund.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 StockinOrderQueryRefund
{
    class StockinOrderQueryRefund
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/stockin_order_query_refund.php";

            client.putParams("start_time", "2019-01-01 00:00:00");
            client.putParams("end_time", "2019-01-17 10:45:00");

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

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 0,
    "message": "",
    "total_count": 1,
    "stockin_list": [{
        "status": "80",
        "stockin_id": "9516",
        "order_no": "RK1905180003",
        "warehouse_no": "xyp2test",
        "warehouse_name": "小鹏测试仓库",
        "stockin_time": "2019-05-18 01:16:15",
        "created_time": "2019-05-18 01:16:14",
        "order_type": "3",
        "goods_amount": "0.0000",
        "total_price": "0.0000",
        "adjust_price": "0.0000",
        "right_price": "0.0000",
        "discount": "0.0000",
        "tax_amount": "0.0000",
        "post_fee": "0.0000",
        "other_fee": "0.0000",
        "remark": "[接口创建库单]",
        "logistics_type": "0",
        "check_time": "2019-05-18 01:16:15",
        "src_order_no": "TK1905180001",
        "goods_count": "1.0000",
        "logistics_name": "无",
        "logistics_code": "",
        "logistics_no": "",
        "actual_refund_amount": "2399.0000",
        "refund_no": "TK1905180001",
        "process_status": "90",
        "customer_no": "KH201811230003",
        "customer_name": "小明",
        "nick_name": "MOB13233456110",
        "shop_name": "lx2test",
        "shop_no": "lx2test",
        "shop_remark": "123",
        "flag_name": "",
        "trade_no": "JY201811230001",
        "trade_type": "网店销售",
        "stockin_reason": "",
        "platform_id": "127",
        "order_type_name": "退货入库",
        "details_list": [{
            "stockin_id": "9516",
            "goods_count": "1.0000",
            "discount": "0.0000",
            "cost_price": "0.0000",
            "production_date": "0000-00-00 00:00:00",
            "validity_days": "0",
            "expire_date": "0000-00-00 00:00:00",
            "src_price": "0.0000",
            "tax_price": "0.0000",
            "tax_amount": "0.0000",
            "tax": "0.0000",
            "total_cost": "0.0000",
            "remark": "",
            "adjust_num": "0.0000",
            "adjust_price": "0.0000",
            "right_num": "1.0000",
            "right_price": "0.0000",
            "right_cost": "0.0000",
            "rec_id": "12793",
            "src_order_detail_id": "4030",
            "goods_name": "旺店通手持终端",
            "goods_no": "WDTPDA",
            "spec_no": "WDTPDA-BLACK006",
            "prop2": "",
            "spec_name": "旺店通手持终端黑色006型",
            "spec_code": "BLACK006",
            "brand_no": "BD201811230002",
            "brand_name": "旺店通",
            "goods_unit": "",
            "batch_no": ""
        }]
    }]
}

   6.2 异常响应示例

JSON
{
    "code": 20,
    "message": "店铺不存在或已经停用"
}



常用工具