当前位置: API文档

purchase_return_query.php(查询采购退货单)

¥标准

1.接口说明

1.1 接口描述:批量获取ERP的采购退货单及明细信息
1.2 适用版本:客户端 V2.4.2.3及以上版本
1.3 增量获取:按照采购单的最后修改时间增量获取数据,请求时输入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地址
测试环境http://sandbox.wangdian.cn/openapi2/purchase_return_query.php
正式环境http://api.wangdian.cn/openapi2/purchase_return_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 业务请求参数

名称字段类型长度必须描述
状态statustinyint
采购退货单状态:10,已取消,20,编辑中,30,待审核,40,已审核,42,待推送,44,推送失败,46,委外待出库,50,部分出库,60,已完成
开始时间start_timedata
按最后修改时间增量获取数据,start_time作为开始时间,时间格式:YYYY-MM-DD HH:MM:SS
结束时间end_timedata
按最后修改时间增量获取数据,end_time作为结束时间,时间格式:YYYY-MM-DD HH:MM:SS
仓库编号warehouse_novarchar40代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置)
分页大小page_sizeint10每页返回的数据条数,输入值范围1~50,不传本参数,输入值默认为50,使用举例单击这里
页号page_noint10不传值默认从0页开始

4.响应参数

   4.1 公共响应参数

名称字段类型长度必须描述
错误码codeint11错误码,0成功
错误描述messagevarchar255错误描述
符合条件的数据条数total_countint11符合条件的数据条数,用来分页 当page_no=0时返回
采购退货单数据节点purchase_listdata[ ]
响应参数的1级数据节点,包含当前页的采购单及其明细的数据节点,节点下数据字段详见下述" purchase_list"details_list

   4.2 业务响应参数

   purchase_list

名称字段类型长度必须描述
采购退货单idreturn_idint11采购退货单主键id
退货单号return_novarchar40退货单号
供应商provider_namevarchar64供应商
采购单状态statustinyint4采购退货单状态:10,已取消,20,编辑中,30,待审核,40,已审核,42,待推送,44,推送失败,46,委外待出库,50,部分出库,60,已完成
仓库编号warehouse_novarchar40代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置)
仓库warehouse_namevarchar64系统仓库名称
采购员id
purchaser_id
int
10
采购员id
采购员名称
purchaser_name
varchar
20
采购员名称
物流类型logistics_typesmallint6物流方式,详情介绍,单击这里
其它费用other_feedecimal(19,4)其它费用
邮费post_feedecimal(19,4)邮费
总货款goods_feedecimal(19,4)总货款
退货开单量goods_countdecimal(19,4)退货开单量
货品种类数goods_type_countint11货品种类数
退货出库量goods_out_countdecimal(19,4)退货出库量
备注remarkvarchar255采购退货单备注
建单时间createddatetime
格式:
YYYY-MM-DD
HH:MM:SS
最后修改时间modifieddatetime
格式:
YYYY-MM-DD
HH:MM:SS
外部接口单号api_outer_novarchar40外部接口单号
采购退货单货品列表节点detail_listdata[ ]
响应参数的2级数据节点,包含采购退货单货货品明细所有属性信息,节点下数据字段详见下述“details_list

   detail_list

名称字段类型长度必须描述
采购退货单idreturn_idint11采购退货单主键id
供应商货品编号provider_goods_novarchar64供应商货品编号
商家编码spec_novarchar40代表单品(sku)所有属性的编码,SKU概念介绍,单击这里
货品编码goods_novarchar40代表货品(spu)所有属性的编号,SPU概念介绍,单击这里
货品名称goods_namevarchar255货品名称
规格名称spec_namevarchar100规格名称
规格码spec_codevarchar40规格码
退货数量numdecimal(19,4)退货数量
辅助退货量num2decimal(19,4)辅助退货量
出库单位unit_idint11出库单位
单位变换率unit_ratiodecimal(19,4)单位变换率
基本单位base_unit_idint11基本单位
单价pricedecimal(19,4)单价
折扣discountdecimal(19,4)折扣
税前金额amountdecimal(19,4)税前金额
出库单位名称
unit_namevarchar20出库单位名称
基本单位名称base_unit_namevarchar20基本单位名称
备注remarkvarchar255货品明细备注

5.请求示例

PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/purchase_order_query.php';
    
    $c->putApiParam('start_time', '2018-06-03 00:00:00');
    $c->putApiParam('end_time', '2018-06-21 20:13:41');
    $c->putApiParam('status', 50);
    $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 PurchaseReturnQuery {

    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("purchase_return_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 PurchaseReturnQuery
{
    class PurchaseReturnQuery
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/purchase_return_query.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": "",
    "total_count": 1,
    "purchase_list": [{
        "return_id": "89",
        "return_no": "CR201905180002",
        "status": "60",
        "logistics_type": "0",
        "other_fee": "0.0000",
        "post_fee": "0.0000",
        "goods_fee": "3699.0000",
        "goods_count": "1.0000",
        "goods_type_count": "1",
        "goods_out_count": "1.0000",
        "remark": "[接口创建采购退货单]",
        "created": "2019-05-18 17:34:54",
        "modified": "2019-05-18 17:52:41",
        "api_outer_no": "",
        "warehouse_name": "小鹏测试仓库",
        "warehouse_no": "xyp2test",
        "provider_name": "旺店通PDA供应商",
        "detail_list": [{
            "return_id": "89",
            "provider_goods_no": "",
            "num": "1.0000",
            "num2": "1.0000",
            "unit_id": "0",
            "unit_ratio": "1.0000",
            "base_unit_id": "0",
            "price": "3699.0000",
            "discount": "1.0000",
            "amount": "3699.0000",
            "unit_name": "",
            "base_unit_name": "",
            "remark": "",
            "spec_no": "WDTPDA-BLACK006",
            "spec_name": "旺店通手持终端黑色006型",
            "spec_code": "BLACK006",
            "goods_no": "WDTPDA",
            "goods_name": "旺店通手持终端"
        }]
    }]
}

   6.2 异常响应示例

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



常用工具