当前位置: API文档

trade_query.php(查询订单管理)

¥标准

1.接口说明

1.1 接口描述:获取ERP销售订单信息
1.2 适用版本:客户端 V2.4.0.5及以上版本
1.3 增量获取:按照ERP订单的最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。
1.4 时间跨度:start_time和end_time最大跨度为60分钟(请注意:订单查询是不同于其他接口,订单的数据量较大,无法按照时间段30天进行查询的)。
1.5 注意事项:本接口不返回淘系订单数据,相关平台规则单击这里。淘系订单数据获取办法单击这里

2.调用场景

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

3.请求参数说明

   3.1 请求地址

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

查询ERP已归档历史订单地址:

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

名称字段类型长度
必须描述
订单状态statustinyint4订单状态 如果不传该字段则查询所有订单   (传该字段:5已取消 10待付款 12待尾款 13待选仓 15等未付16延时审核 19预订单前处理 20前处理(赠品,合并,拆分)21委外前处理22抢单前处理 25预订单 27待抢单 30待客审 35待财审 40待递交仓库 45递交仓库中 50已递交仓库 53未确认 55已确认(已审核) 95已发货 105部分打款 110已完成)
开始时间start_timedata
按最后修改时间增量获取数据,start_time作为开始时间,格式: YYYY-MM-DD HH:MM:SS
结束时间end_timedata
按最后修改时间增量获取数据,end_time作为结束时间,格式: YYYY-MM-DD HH:MM:SS
分页大小page_sizeint
每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40,使用举例单击这里
页号page_noint
不传值默认从0页开始
原始单号src_tidvarchar40如果使用原始单号,其余参数不起效。其余参数可以不传
货品信息是否返回图片urlimg_urltinyint1货品信息是否返回图片url,0不返回,1返回
订单编号trade_novarchar40系统订单编号,默认单号为JY开头,ERP内支持自定义(设置路径:设置——编码设置)
店铺编号shop_novarchar40代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),用于获取指定店铺单据数据信息
仓库编号warehouse_novarchar40代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置),用于获取指定仓库单据数据信息(不支持一次推送多个仓库编码)
使用税率goodstaxtinyint10 使用订单中的税率 1 使用单品中的税率(默认0)
物流单号限制has_logistics_notinyint10 没有任何限制(默认值) 1 物流单号不为空才返回 2 只返回物流单号为空的
是否返回交易流水号、付款状态、付款时间srctinyint11 (返回 ),0 (不返回)(不传默认值0)
物流单号logistics_novarchar40物流单号

4.响应参数

   4.1 公共响应参数

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

   4.2 业务响应参数

  trades

名称字段类型长度
必须描述
erp订单表的主键trade_idint11erp订单表的主键
订单编号trade_novarchar40系统订单编号,默认单号为JY开头,ERP内支持自定义订单编号生成规则(设置路径:设置——编码设置)
平台IDplatform_idtinyint4响应值为代表平台的ID数字,ID对应的平台名称单击这里
店铺编号shop_novarchar20代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置)
店铺名称shop_namevarchar128店铺名称
店铺备注shop_remarkvarchar
店铺备注
仓库类型warehouse_typetinyint40不限 1普通仓库 2自动流转外部 3京东仓储 4科捷 5百世物流 6 SKU360 7通天晓 8中联网仓 9顺丰仓储 10网仓2号 11奇门仓储 12旺店通仓储 13心怡仓储 14力威仓储 15京东沧海 16云集仓储 127其他
仓库编号warehouse_novarchar40代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置)(根据编号可查询仓库名称)
原始单号src_tidsvarchar255商城或电商平台的订单编号,合并订单的多个订单编号有逗号隔开
订单状态trade_statustinyint4订单状态 5已取消 10待付款 12待尾款 13待选仓 15等未付16延时审核 19预订单前处理 20前处理(赠品,合并,拆分)21委外前处理22抢单前处理 25预订单 27待抢单 30待客审 35待财审 40待递交仓库 45递交仓库中 50已递交仓库 53未确认 55已确认(已审核) 95已发货 105部分打款 110已完成’
发货状态consign_statusint11出库状态:0表示无出库状态,1验货2称重4出库8物流同步16分拣(注意:如果是3,则表示完成了验货和称重“1+2”,如果是15,则表示四个过程都完成了“1+2+4+8”,其他数字以此类推)
订单类型trade_typetinyint11网店销售 2线下零售 3售后换货 4批发业务 5保修换新 6保修完成 7订单补发 .. 101自定义类型1 102自定义类型2 103自定义类型3 104自定义类型4 105自定义类型5 106自定义类型6
发货条件delivery_termtinyint4发货条件 1款到发货 2货到付款(包含部分货到付款),4挂账
冻结原因freeze_reasonsmallint6冻结原因
退款状态refund_statustinyint1退款状态 0无退款 1申请退款 2部分退款 3全部退款 4未付款关闭或手工关闭
分销类别fenxiao_typetinyint4分销类别 0非分销订单 1代销 2经销
分销商名称fenxiao_nickvarchar40分销商名称
下单时间trade_timedatetime
下单时间
付款时间pay_timedatetime
付款时间
客户名称customer_namevarchar40客户名称
客户编码customer_novarchar40客户编码
买家付款账号pay_accountvarchar128淘系平台不返回,其他平台正常返回
客户网名buyer_nickvarchar100淘系平台不返回,其他平台正常返回
收件人receiver_namevarchar40淘系平台不返回,其他平台正常返回
收件人省份receiver_provinceint11收件人的省份
收件人城市receiver_cityint11收件人的城市
收件人地区receiver_districtint11收件人的地区
地址receiver_addressvarchar256淘系平台不返回,其他平台正常返回
手机receiver_mobilevarchar40淘系平台不返回,其他平台正常返回
电话receiver_telnovarchar40淘系平台不返回,其他平台正常返回
邮编receiver_zipvarchar20收件人邮编
省市县receiver_areavarchar128省市县空格分隔
区域receiver_ringvarchar20收件人区域
大头笔receiver_dtbvarchar128大头笔
派送时间to_deliver_timevarchar20派送时间 如周一至周五,上午
异常订单bad_reasonint11异常订单(bit位),1无库存记录 2地址发生变化 4发票变化 8仓库变化 16备注变化 32平台更换货品 64退款
物流公司IDlogistics_idsmallint6物流公司ID
物流公司名称logistics_namevarchar40物流公司名称
物流公司编号logistics_codevarchar20代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置)
物流方式logistics_typesmallint6响应值为代表物流方式的数字,数字对应的物流方式名称单击这里
物流单号logistics_novarchar40物流单号
买家留言buyer_messagevarchar1024买家留言
客服备注cs_remarkvarchar1024客服备注
标旗remark_flagtinyint4标旗
打印备注print_remarkvarchar255打印备注
货品种类数goods_type_countsmallint6货品种类数
货品总数goods_countdecimal19,4货品总数
货品总额goods_amountdecimal19,4货品总额(未扣除优惠),sum(share_amount+discount)所得
邮资post_amountdecimal19,4邮费
其它费用other_amountdecimal19,4其它从买家的收费(非订单支付金额以及服务费),从原始订单列表继承
折扣discountdecimal19,4订单优惠,系统子订单“优惠”求合所得
应收金额receivabledecimal19,4应收金额,系统订单的(“货品总额”+“邮资”-“折扣”)所得
款到发货金额dap_amountdecimal19,4款到发货金额,paid>=dap_amount才可发货
COD金额cod_amountdecimal19,4货到付款订单金额,系统子订单的(“分摊后总价”+“分摊邮费”-“已付”)再求和
买家COD费用ext_cod_feedecimal19,4货到付款非订单金额,从原始订单继承
货品预估成本goods_costdecimal19,4货款预估成本
邮资成本post_costdecimal19,4预估邮费成本
已付金额paiddecimal19,4已付金额,系统子订单“已付”求合所得
预估重量weightdecimal19,4预估重量
预估毛利profitdecimal19,4预估毛利
税额taxdecimal19,4税额
税率tax_ratedecimal19,4税率
佣金commissiondecimal19,4佣金
发票类型invoice_typetinyint4发票类别 0 不需要,1普通发票,2增值普通税发票,3增值专用税发票
发票抬头invoice_titlevarchar255发票抬头
发票内容invoice_contentvarchar255发票内容
业务员salesman_idint11业务员ID
审核人checker_idint11审核员工ID
业务员姓名fullnamevarchar40业务员姓名
审核人checker_namevarchar40审核员工姓名
财审人fchecker_idint11财审操作员ID
签出人checkouter_idint11签出员工id
出库单号stockout_novarchar40出库单号,内部或外部仓库的订单号
标记名称flag_namevarchar40背景色标记名称
订单来源trade_fromtinyint1订单来源 1API抓单,2手工建单 3excel导入 4现款销售
货品商家编码single_spec_novarchar40货品商家编码
原始货品数量raw_goods_countdecimal19,4原始货品数量
原始货品种类数raw_goods_type_countint6原始货品种类数
币种currencyvarchar20币种
线上包裹拆分数split_package_numint11已拆分包裹数
发票IDinvoice_idint11目前只设0-1,1表示已开发票
版本号version_idsmallint6订单每修改一次,版本号做一次变更
最后修改时间modifieddatetime
最后修改时间
订单生成时间createddatetime
系统单生成时间
证件类别id_card_typetinyint4证件类别
证件号码id_cardvarchar40淘系平台不返回,其他平台正常返回
货品列表节点goods_listdata[]
响应参数的2级数据节点,包含系统订单货品明细所有属性信息的数据节点,节点下数据字段详见下述"goods_list"

   goods_list

名称字段类型长度
必须描述
erp子订单主键rec_idint11erp子订单主键
erp订单主键trade_idint11erp订单主键
erp内商品主键spec_idint11erp内商品主键
平台platform_idtinyint4平台ID
子订单编号src_oidvarchar40原始子订单号
平台货品IDplatform_goods_idvarchar40平台货品ID
平台商品IDplatform_spec_idvarchar40平台商品ID
组合装IDsuite_idint11如果货品是由组合装拆分的,这里组合装ID
区分子单拆分的唯一性标记flagint11子单拆分时,单品明细都一致,用来区分子单的唯一性
原始订单编号src_tidvarchar40原始订单号
赠品方式gift_typetinyint1是否是赠品 0非赠品 1自动赠送 2手工赠送
退款状态refund_statustinyint4退款状态 0无退款,1取消退款,2已申请退款,3等待退货,4等待收货,5退款成功
担保方式guarantee_modetinyint41担保 2非担保 3在线非担保
发货条件delivery_termtinyint41款到发货 2货到付款(包含部分货到付款) 3分期付款
关联发货bind_oidvarchar40关联发货
下单数量numdecimal19,4货品数量
标价pricedecimal19,4销售单价,手工新建时使用货品属性中的“零售价”
实发数量actual_numdecimal19,4实发数量,此数量为发货数量,删除操作等于将此值设置为0
售后退款数量refund_numdecimal19,4售后退款数量
成交价order_pricedecimal19,4成交价,原始单折扣及分摊之后的价格
分摊后价格share_pricedecimal19,4进入ERP后再次调整的价格,默认值与order_price一致
手工调整价adjustdecimal19,4手工调整价,正数为加价,负数为减价
总折扣金额discountdecimal19,4总折扣金额
分摊后总价share_amountdecimal19,4分摊后合计应收=share_price * num , share_price 是根据share_amount反推的,因此share_price可能有精度损失
分摊邮费share_postdecimal19,4分摊邮费
已付paiddecimal19,4已支付金额
货品名称goods_namevarchar255货品名称
自定义属性2prop2varchar255自定义属性2
货品idgoods_idint11货品id
货品编号goods_novarchar40代表货品(spu)所有属性的唯一编号,用于系统货品区分,,SPU概念介绍单击这里
规格名spec_namevarchar100规格名
商家编码spec_novarchar40代表单品(sku)所有属性的唯一编码,用于系统单品区分,SKU概念介绍,单击这里
规格码spec_codevarchar40规格码
组合装编码suite_novarchar40代表组合装商品所有属性的唯一编码,用于系统组合装商品的区分
拆自组合装suite_namevarchar255如果是组合装拆分的,此为组合装名称
组合装数量suite_numdecimal19,4组合装数量
组合装分摊后总价suite_amountdecimal19,4组合装分摊后总价
组合装优惠suite_discountdecimal19,4组合装优惠
平台货品名称api_goods_namevarchar255平台货品名称
平台规格名称api_spec_namevarchar100平台规格名称
估重weightdecimal19,4预估单个货品重量
佣金commissiondecimal19,4佣金
货品类别goods_typetinyint41销售商品 2原材料 3包装 4周转材料5虚拟商品 0其它
大件类型large_typetinyint1大件类型 0非大件 1普通大件 2独立大件
发票类别invoice_typetinyint4发票类别,0 不需要,1普通发票,2增值税发票
发票内容invoice_contentvarchar255发票内容
原始单标记from_maskint11订单内部来源1手机,2聚划算,4服务子订单,8家装,16二次付款,32开具电子发票,128指定批次,2048当日达,4096次日达,8192预计时效,262144天猫直送/唯品仓中仓,524288‘3PL时效/jitx’,2097152区域零售,4194304预售单,8388608周期购
类目idcidint11类目id
备注remarkvarchar60货品明细备注
最后修改时间modifieddatetime
最后修改时间
创建时间createddatetime
创建时间
税率tax_ratedecimal8,4税率(根据条件使用订单中或单品中税率)
基本单位base_unit_idsmallint6基本单位ID
基本单位名称unit_namevarchar20基本单位名称
交易流水单号pay_idvarchar40交易流水单号
子单付款状态pay_statustinyint40(未付款),1(部分付款),2(已付款)如需响应该字段,请将ERP升级到V2.3.8.3及以上。
子单付款时间pay_timedatetime
格式: YYYY-MM-DD HH:MM:SS,如需响应该字段,请将ERP升级到V2.3.8.3及以上。

5.请求示例

PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/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 TradeQuery {

    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("trade_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 TradeQuery
{
    class TradeQuery
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/trade_query.php";

            client.putParams("start_time", "2018-12-23 06:02:02");
            client.putParams("end_time", "2018-12-23 06:05:02");

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

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 0,
    "message": "",
    "total_count": 1,
    "trades": [{
        "trade_id": "168498",
        "trade_no": "JY201905180001",
        "platform_id": "0",
        "warehouse_type": "1",
        "src_tids": "115580935277840368-1",
        "pay_account": "默认账户",
        "trade_status": "30",
        "consign_status": "0",
        "trade_type": "2",
        "delivery_term": "1",
        "freeze_reason": "0",
        "refund_status": "0",
        "fenxiao_type": "0",
        "fenxiao_nick": "",
        "trade_time": "2019-05-18 00:25:17",
        "pay_time": "2019-05-18 00:25:17",
        "buyer_nick": "ffasdasd",
        "receiver_name": "小鹏",
        "receiver_province": "310000",
        "receiver_city": "310100",
        "receiver_district": "310109",
        "receiver_address": "龙茗路9号",
        "receiver_mobile": "13456554333",
        "receiver_telno": "01000860086",
        "receiver_zip": "10089",
        "receiver_area": "上海 上海市 虹口区",
        "receiver_ring": "",
        "receiver_dtb": "上海市 虹口区",
        "to_deliver_time": "",
        "bad_reason": "0",
        "logistics_no": "",
        "buyer_message": "请发顺丰",
        "cs_remark": "发顺丰快递",
        "remark_flag": "0",
        "print_remark": "",
        "goods_type_count": "1",
        "goods_count": "2.0000",
        "goods_amount": "198.0000",
        "post_amount": "0.0000",
        "other_amount": "0.0000",
        "discount": "0.0000",
        "receivable": "198.0000",
        "dap_amount": "198.0000",
        "cod_amount": "0.0000",
        "ext_cod_fee": "0.0000",
        "goods_cost": "0.0000",
        "post_cost": "0.0000",
        "paid": "198.0000",
        "weight": "0.0000",
        "profit": "198.0000",
        "tax": "0.0000",
        "tax_rate": "0.0000",
        "commission": "0.0000",
        "invoice_type": "0",
        "invoice_title": "",
        "invoice_content": "",
        "salesman_id": "1",
        "checker_id": "0",
        "fchecker_id": "0",
        "checkouter_id": "0",
        "stockout_no": "",
        "flag_name": "VIP",
        "trade_from": "2",
        "single_spec_no": "WDTPDA-BLACK006",
        "raw_goods_count": "2.0000",
        "raw_goods_type_count": "1",
        "currency": "",
        "split_package_num": "0",
        "invoice_id": "0",
        "version_id": "1",
        "modified": "2019-05-18 00:31:00",
        "created": "2019-05-18 00:30:59",
        "id_card_type": "0",
        "id_card": "",
        "shop_no": "xyp2test",
        "shop_name": "小鹏测试店铺",
        "shop_remark": "勿更改本店铺内容",
        "warehouse_no": "xyp2test",
        "customer_name": "h",
        "customer_no": "KH201905170008",
        "logistics_id": "1",
        "logistics_name": "顺丰快递",
        "logistics_code": "SF001",
        "logistics_type": "8",
        "fullname": "admin",
        "checker_name": "系统",
        "goods_list": [{
            "rec_id": "294491",
            "trade_id": "168498",
            "spec_id": "1",
            "platform_id": "0",
            "src_oid": "AD201905180001",
            "suite_id": "0",
            "src_tid": "115580935277840368-1",
            "gift_type": "0",
            "refund_status": "0",
            "guarantee_mode": "2",
            "delivery_term": "1",
            "bind_oid": "",
            "num": "2.0000",
            "price": "99.0000",
            "actual_num": "2.0000",
            "refund_num": "0.0000",
            "order_price": "99.0000",
            "share_price": "99.0000",
            "adjust": "0.0000",
            "discount": "0.0000",
            "share_amount": "198.0000",
            "share_post": "0.0000",
            "paid": "198.0000",
            "goods_name": "旺店通手持终端",
            "goods_id": "1",
            "goods_no": "WDTPDA",
            "spec_name": "旺店通手持终端黑色006型",
            "spec_no": "WDTPDA-BLACK006",
            "spec_code": "BLACK006",
            "suite_no": "",
            "flag": "0",
            "suite_name": "",
            "suite_num": "0.0000",
            "suite_amount": "0.0000",
            "suite_discount": "0.0000",
            "api_goods_name": "旺店通手持终端",
            "api_spec_name": "旺店通手持终端黑色006型",
            "weight": "0.0000",
            "commission": "0.0000",
            "goods_type": "1",
            "large_type": "0",
            "invoice_type": "0",
            "invoice_content": "",
            "from_mask": "131072",
            "cid": "0",
            "remark": "",
            "modified": "2019-05-18 00:31:00",
            "created": "2019-05-18 00:31:00",
            "platform_goods_id": "",
            "platform_spec_id": "1",
            "prop2": "",
            "tax_rate": "0.0000"
        }]
    }]
}

   6.2 异常响应示例

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



常用工具