当前位置: API文档

vip_api_trade_query.php(查询原始订单

¥增值

1.接口说明

1.1 接口描述:查询电商平台的销售订单数据
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注意事项:本接口不返回淘系订单数据,相关平台规则单击这里。淘系订单数据获取办法单击这里
隐私字段列表
字段描述字段名
客户网名buyer_nick
买家支付宝账号pay_account
收货人姓名receiver_name
收货人详细地址receiver_address
收货人手机号码receiver_mobile
收货人电话号码receiver_telpho
收货人邮箱

receiver_emai

2.调用场景

2.1 获取原始订单界面的相关数据。

3.请求参数说明

   3.1 请求地址

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

查询历史原始单地址:

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

名称字段类型长度
必须描述
原始单号
tid
varchar40

商城平台的单号
平台id
platform_idtinyint4
平台id
店铺编号
shop_no
varchar
40
店铺编号
开始时间
start_time
datatime

按最后修改时间增量查询数据,start_time作为开始时间,格式:YYYY-MM-DD HH:MM:SS
结束时间
end_time
datatime

按最后修改时间增量查询数据,end_time作为结束时间,格式:YYYY-MM-DD HH:MM:SS
页号
page_no
int

页号,不传默认从0页开始
分页大小
page_size
int

每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40,使用举例单击这里

4.响应参数

   4.1 公共响应参数

名称字段类型长度必须描述
错误码codeint11状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
条数
total_countvarchar255符合查询条件的总数量,只有page_no = 0 时才有值。
原始单节点
trade_listdata[]
业务数据的一级节点,数组形式的订单数据,需要循环读取。

   4.2 业务响应参数

    trade_list

名称
字段类型长度必须描述
平台

platform_id

tinyint4
平台id
店铺编号shop_novarchar40店铺编号
原始单号tid
varchar40原始单号
平台状态
trade_status
tinyint4平台状态:10未确认 20待尾款 30待发货 40部分发货 50已发货 60已签收 70已完成 80已退款 90已关闭(付款前取消)
担保方式
guarantee_modetinyint4担保方式:1担保交易2非担保交易3非担保在线交易
支付状态
pay_status
tinyint4支付状态:0未付款 1部分付款 2已付款
发货条件
delivery_term
tinyint4发货条件:1.款到发货  2.货到付款  3.分期付款  4.挂账单
支付方式
pay_method
tinyint4支付方式:1.在线转账  2.现金  3.银行转账  4.邮局汇款  5.预付款  6.刷卡  7.支付宝  8.微信支付
退款状态
refund_status
tinyint4退款状态: 0.无退款  1.申请退款  2.部分退款  3.全部退款
系统状态
process_status
tinyint4

系统状态:10.待递交 15.部分递交 20.已递交 30.部分发货 40.已发货 50.部分结算 60.已完成 70.已取消

下单时间
trade_time
datetime

下单时间

支付时间
pay_time
datetime

支付时间

买家留言
buyer_message
varchar
255

买家留言

客服备注
remark
varchar
255

客服备注

货款
goods_amount
decimal
(19,4)

货款

邮费
post_amount
decimal
(19,4)

邮费

其他费用
other_amount
decimal
(19,4)

其他费用

优惠
discount
decimal
(19,4)

优惠

已付金额
paid
decimal
(19,4)

已付金额

平台费用

platform_cost

decimal
(19,4)

平台费用

已收金额

received

decimal
(19,4)

已收金额

应收金额

receivable

decimal
(19,4)

应收金额

款到发货金额

dap_amount

decimal
(19,4)

款到发货金额

货到付款金额

cod_amount

decimal
(19,4)

货到付款金额

退款金额

refund_amount

decimal
(19,4)

退款金额

物流方式

logistics_type

tinyint4

物流方式,-1表示自由选择

发票类别

invoice_type

tinyint4

发票类别:0.不需要  1.普通发票  2.普通增值发票  3.专用增值发票

发票抬头

invoice_title

varchar
255

发票抬头

发票内容

invoice_content

varchar
255

发票内容

结束时间

end_time

datetime

结束时间

分销方式

fenxiao_type

tinyint4

分销方式:0.非分销订单  1.转供销  2.代销  3.经销

订单来源

trade_from

tinyint4

订单来源:1.API抓单  2.手工建单  3.excel导入  4.现款销售  5.外部推送

修改时间

modified

datetime

修改时间

创建时间

created

datetime

创建时间

币种

currency

varchar
20

币种

积分

score

int
11

积分

货品明细

goods_list

data[ ]

业务数据的二级节点,货品明细

优惠明细

discount_list

data[ ]

业务数据的二级节点,优惠明细

    goods_list

名称
字段类型长度必须描述
平台

platform_id

tinyint4
平台id
子单原始单号tid
varchar40原始单号
原始子单号oid
varchar40平台订单货品表主键,子订单唯一标识,同一个sid下通过本接口新增订单的oid(子订单编号)要保证唯一;如果oid重复,ERP生成系统单(递交)时会提示“订单货品数量不一致xxxxxx”
状态
status
tinyint4状态:10未确认 20待尾款 30待发货 40部分发货 50已发货 60已签收 70已完成 80已退款 90已关闭
系统状态
process_status
tinyint4

系统状态:10.待递交 15.部分递交 20.已递交 30.部分发货 40.已发货 50.部分结算 60.已完成 70.已取消

退款状态
refund_status
tinyint4退款状态: 0.无退款  1.取消退款  2.已申请退款  3.等待退货  4.等待收货  5.退款成功
子订单类型
order_type
tinyint4子订单类型:0.正常货品  1.虚拟货品  2.服务
平台货品ID
goods_id
varchar
40平台货品ID
平台规格ID
spec_id
varchar
40平台规格ID
平台货品编码
goods_no
varchar
40平台货品编码
平台规格编码
spec_no
varchar
40平台规格编码
平台货品名称
goods_name
varchar
255
平台货品名称
平台规格名称
spec_name
varchar
255
平台规格名称
数量
num
decimal
(19,4)数量
单价
price
decimal
(19,4)单价
调整金额
adjust_amount
decimal
(19,4)调整金额
优惠
discount
decimal
(19,4)优惠
总价
total_amount
decimal
(19,4)总价
分摊优惠
share_discount
decimal
(19,4)分摊优惠
分摊后总价
share_amount
decimal
(19,4)分摊后总价
分摊邮资
share_post
decimal
(19,4)分摊邮资
已付金额
paid
decimal
(19,4)已付金额
发票类别

invoice_type

tinyint4

发票类别:0.不需要  1.普通发票  2.普通增值发票  3.专用增值发票

发票内容

invoice_content

varchar
255

发票内容

关联子订单

bind_oid

varchar
40
关联子订单
退款单编号

refund_id

varchar
40
退款单编号
退款单金额

refund_amount

decimal(19,4)退款金额
备注

remark

varchar255备注
修改时间

modified

datetime

修改时间

创建时间

created

datetime

创建时间

子单完成时间

end_time

datetime

子单完成时间

    discount_list

名称
字段类型长度必须描述
平台

platform_id

tinyint4
平台id
原始单号tid
varchar40原始单号
原始子单号oid
varchar40原始子订单编号
优惠名称
name
varchar255
优惠名称
优惠详情
detail
varchar255
优惠详情
优惠金额
amount
decimal(19,4)
优惠金额


5.请求示例

PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/vip_api_trade_query.php';
  
    $c->putApiParam('start_time','2018-01-01 00:00:00');
    $c->putApiParam('end_time','2018-01-01 01:00:00');
    $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 ApiTradeQuery {      //"ApiTradeQuery可自定义"
  
    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-11 12:00:00");
        params.put("end_time", "2018-12-11 13:00:00");
        params.put("page_size", "30");
        params.put("page_no", "0");
          
        try {
            String response = client.execute("vip_api_trade_query.php", params);
            System.out.println(response);
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
  
}
C#
package com.wangdian.api.trade;
  
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
  
import com.wangdian.api.WdtClient;
  
public class ApiTradeQuery {      //"ApiTradeQuery可自定义"
  
    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-11 12:00:00");
        params.put("end_time", "2018-12-11 13:00:00");
        params.put("page_size", "30");
        params.put("page_no", "0");
          
        try {
            String response = client.execute("vip_api_trade_query.php", params);
            System.out.println(response);
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
  
}

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 0,
    "message": "",
    "total_count": "1",
    "trade_list": [{
        "platform_id": "0",
        "shop_no": "jszc2-test",
        "tid": "wjw20190726002-1",
        "process_status": "20",
        "trade_status": "10",
        "guarantee_mode": "2",
        "pay_status": "2",
        "delivery_term": "1",
        "pay_method": "1",
        "refund_status": "0",
        "trade_time": "2019-08-01 19:40:06",
        "pay_time": "2019-08-01 19:40:06",
        "buyer_message": "",
        "remark": "换货销售单",
        "to_deliver_time": "",
        "receivable": "2.0000",
        "goods_amount": "0.0000",
        "post_amount": "0.0000",
        "other_amount": "0.0000",
        "discount": "-2.0000",
        "paid": "2.0000",
        "platform_cost": "0.0000",
        "received": "2.0000",
        "dap_amount": "0.0000",
        "cod_amount": "0.0000",
        "pi_amount": "0.0000",
        "refund_amount": "0.0000",
        "logistics_type": "-1",
        "invoice_type": "0",
        "invoice_title": "",
        "invoice_content": "",
        "trade_from": "2",
        "fenxiao_type": "0",
        "end_time": "0000-00-00 00:00:00",
        "modified": "2019-08-01 19:40:06",
        "created": "2019-08-01 19:40:06",
        "currency": "",
        "score": "0",
        "goods_list": [{
            "platform_id": "0",
            "tid": "wjw20190726002-1",
            "oid": "AD201908010005",
            "status": "30",
            "process_status": "20",
            "refund_status": "0",
            "order_type": "0",
            "invoice_type": "0",
            "invoice_content": "",
            "bind_oid": "",
            "goods_id": "99279",
            "spec_id": "238768",
            "goods_no": "add_100002",
            "spec_no": "add_100002_03",
            "goods_name": "测试售罄的商品",
            "spec_name": "有+1",
            "refund_id": "",
            "num": "1.0000",
            "price": "0.0000",
            "adjust_amount": "0.0000",
            "discount": "-2.0000",
            "share_discount": "0.0000",
            "total_amount": "0.0000",
            "share_amount": "2.0000",
            "share_post": "0.0000",
            "paid": "2.0000",
            "refund_amount": "0.0000",
            "modified": "2019-08-01 19:40:06",
            "created": "2019-08-01 19:40:06",
            "end_time": "",
            "remark": ""
        }],
        "discount_list": []
    }]
}

   6.2 异常响应示例

JSON
{
    "code": 1060,
    "message": "充值余额为0或应用已欠费,请联系商务充值 "
}



常用工具