当前位置: API文档

sales.TradeQuery.queryWithDetail(订单查询)

¥标准

1.接口说明

1.1 接口描:获取ERP系统内订单信息
1.2 适用版本:客户端 V1.4.3.2及以上版本
1.3 增量获取:支持
1.4 时间跨度:start_time和end_time最大跨度为60分钟。

1.5注意事项:权限校验:【店铺权限】

为了达到保护用户隐私数据安全的目的本接口不返回淘系及系统供销平台订单数据相关平台规则点击这里淘系及系统供销平台数据获取办法点击这里

本接口中涉及到用户隐私的字段数据仅自有平台及线下平台订单返回,具体字段详见下述“隐私字段列表”


通过从后往前翻页的方式可以避免漏单问题。

字段描述字段名
买家支付宝账号pay_account
买家昵称buyer_nick
收件人姓名receiver_name
收件地址receiver_address
收件人手机receiver_mobile
收件人固话
receiver_telno
客户姓名customer_name

2.调用场景

2.1 举例说明:财务系统、SAP、数据分析等系统的对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://47.92.239.46/openapi
正式环境http://wdt.wangdian.cn/openapi

   3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
卖家账号, 由旺店通分配
接口账号keyString
由旺店通分配appkey, 在发送的数据中对应 key 字段
saltString
由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称methodString
调用的接口名称
版本号vString
1.0
秒级时间戳timestampint
秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名signString
签名
分页大小page_sizeint
分页大小,分页查询必传
分页编号page_noint
分页编号,分页查询必传,标准接口page_no从0开始
是否计算查询结果的总条数calc_totalint
是否计算查询结果的总条数, 需要计算则1, 否则填0         

    3.3 业务请求参数

名称字段类型长度
必须描述
查询参数

params

Map<String, Object>
y

查询参数

分页

pager

Pager


y

分页

params

名称字段类型长度
必须描述
开始时间

start_time

String

40y修改起始时间,若无订单号,则为必填。示例:“ 2021-11-11 00:00:00”
结束时间end_timeString40y
修改结束时间,上同开始时间。示例:“ 2021-11-11 01:00:00”
仓库编号

warehouse_no

String

40n仓库编号
订单状态

status

String

255n

若多个状态则以“,”隔开。

订单状态:  

4 线下退款

5已取消

6 待转预订单(待审核)

7 待转已完成

10未付款

12待尾款

15等未付

16延时审核

19预订单前处理

20 审核前处理

21自流转待发货

23 异常订单

24 换货预订单

25 待处理预订单

27待分配预订单 

30待客审

35待财审

55已审核

95已发货

96 成本确认(待录入计划成本,订单结算时有货品无计划成本)

101 已过账

110已完成

(状态字段含义点击链接查看

订单编号

trade_no

String40n订单编号
店铺编号

shop_no

String20n店铺编号
物流单号
logistics_noString40n物流单号
原始单号src_tidString40n原始单号, 多个原始单号之间使用英文逗号分隔
是否使用从库查询is_slaveboolean1n

使用:true   不使用:false

(仅对开通从库配置客户生效)

pager

名称字段类型长度
必须描述
分页大小

page_size

Int4n

分页大小(单量较大的卖家,page_size建议200以下)

页号

page_no

Int

4n

从0开始

4.响应参数

   4.1 公共响应参数

名称字段类型长度
必须描述
状态码

status

Int
y

状态码,0表示调用成功

错误信息

message

String


y

无错误信息不返回

单据数据

data

Map<String, Object>


y

单据数据

data

名称字段类型长度
必须描述
单据数据orderList<Map<String, Object>>
y订单相关数据
总数total_countInt11n查询条件总单据数
order




订单唯一键trade_idlong
y
订单唯一键
订单编号trade_noString40y订单编号(旺店通系统订单号)
平台IDplatform_idInt4y平台ID(请点击平台代码表查看对应关系
仓库类型warehouse_typeInt4y仓库类型:

1、普通仓库,大于1为委外仓库(如京东仓储,物流宝等)

原始单号src_tidsString255y原始单号(平台订单号),如果有多个,以","分隔,且以增序排列,不重复,过长将被裁剪
平台支付帐号pay_accountString128y

平台支付帐号, (仅自有平台及线下平台返回,其他平台均不返回

订单状态trade_statusString255y

订单状态:  

4 线下退款

5已取消

6 待转预订单(待审核)

7 待转已完成

10未付款

12待尾款

15等未付

16延时审核

19预订单前处理

20 审核前处理

21自流转待发货

23 异常订单

24 换货预订单

25 待处理预订单

27待分配预订单 

30待客审

35待财审

55已审核

95已发货

96 成本确认(待录入计划成本,订单结算时有货品无计划成本)

101 已过账

110已完成

订单类型trade_typeInt4y

订单类型:

1、网店销售

2、线下订单

3、售后换货

4、批发业务

7、现款销售

8、分销订单

101、自定义类型一

102、自定义类型二

103、自定义类型三

104、自定义类型四

105、自定义类型五

106、自定义类型六

(与ERP中自定义类型的映射关系,点击链接查看

发货条件delivery_termInt4y发货条件:

1、款到发货

2、货到付款(包含部分货到付款)

  3、分期付款

  4、挂账

京东几环receiver_ringString20
y京东几环(淘宝模糊化后的买家昵称)
冻结原因freeze_reasonString32y冻结原因
退款状态refund_statusInt4y

退款状态:

0、无退款

1、申请退款

2、部分退款

3、全部退款

分销类别fenxiao_typeInt4y

分销类别:

0、非分销订单

1、代销

2、经销

分销商昵称fenxiao_nickString40
y分销商昵称
下单时间trade_timeString40y下单时间(毫秒级时间戳,例如:1631861379000)
支付时间pay_timeString40y支付时间,例如:2020-10-19 00:00:00
发货时间consign_timeString40y发货时间,订单未发货不返回该字段(毫秒级时间戳,例如:1631861379000)
客户网名buyer_nickString100y

客户网名(淘宝ouid,淘系平台不返回), (仅自有平台及线下平台返回,其他平台均不返回

收货人/收件人receiver_nameString100y

收货人/收件人, (仅自有平台及线下平台返回,其他平台均不返回

省份idreceiver_provinceInt11y省份id,可参考城市代码表
城市idreceiver_cityInt11y城市id,可参考城市代码表
地区idreceiver_districtInt11y地区id,可参考城市代码表
地址receiver_addressString256y

收件人地址, (仅自有平台及线下平台返回,其他平台均不返回

手机receiver_mobileString40y手机,仅自有平台及线下平台返回,其他平台均不返回
固话receiver_telnoString40y

固话, 仅自有平台及线下平台返回,其他平台均不返回

邮编receiver_zipString20y邮编
地区receiver_areaString128y省市区空格分隔
大头笔receiver_dtbString128y大头笔
异常订单原因bad_reasonInt11y

异常订单原因(位运算):

2、修改地址

4、修改发票

8、更换仓库

16、修改备注

32、更换货品

128、拦截赠品

256、拦截换货

512、买家留言变化

1024、拦截平台已发货

物流单号logistics_noString40y物流单号
买家留言buyer_messageString1024y买家留言
客服备注cs_remarkString1024y客服备注
标旗remark_flagInt4y标旗(1 红、2 黄、3 绿、4 蓝、5 紫 )
打印备注print_remarkString1024y打印备注
货品种类数goods_type_countDecimal(19,4)
y货品种类数
货品总量goods_countDecimal(19,4)
y货品总量
总货款goods_amountDecimal(19,4)
y总货款(折前总额)
邮费post_amountDecimal(19,4)
y邮费(买家支付邮费)
其他收费other_amountDecimal(19,4)
y其他收费
优惠discountDecimal(19,4)
y优惠
应收receivableDecimal(19,4)
y应收
货到付款金额cod_amountDecimal(19,4)
y货到付款金额
买家COD费用ext_cod_feeDecimal(19,4)
y买家COD费用
预估货品成本goods_costDecimal(19,4)
y货品预估成本
预估邮资成本post_costDecimal(19,4)
y预估邮资成本
预估重量weightDecimal(19,4)
y预估重量(kg)
预估毛利profitDecimal(19,4)
y预估毛利
税额taxDecimal(19,4)
y税额
税率tax_rateDecimal(19,4)
y税率
佣金commissionDecimal(19,4)
y佣金
发票类型invoice_typeInt4y

发票类型:

0:不需要
1:电子普通发票
2:增值税普通发票
3:电子增值税专用发票
4:纸质普通发票
5:纸质增值税专用发票

发票抬头invoice_titleString1024y发票抬头
发票内容invoice_contentString1024y发票内容
业务员

salesman_name

String40y业务员
审核人checker_nameString40y
审核人
财审人fchecker_nameString40y财审人
签出人

checkouter_name

String40y签出人
出库单号stockout_noString40y出库单号(系统产生的出库单号)
标记名称flag_nameString32y标记名称
订单来源trade_fromInt4y

订单来源:

1、API抓单

2、手工建单

3、导入

4、复制订单

5、接口推送

6、补发订单

7、PDA选货开单

8、分销补发订单

货品商家编码single_spec_noString40y货品商家编码,多种货品为空,组合装时为组合装编码
原始货品数量raw_goods_countDecimal(19,4)
y原始货品数量
原始货品种类数raw_goods_type_countInt6y原始货品种类数
币种currencyString20y币种
发票IDinvoice_idInt11y发票ID(自增生成),0代表没有发票或已取消/已冲红
版本号version_idInt6y版本号
修改时间modifiedString40y修改时间,例如:2020-10-19 00:00:00
创建时间createdString40
y创建时间(毫秒级时间戳,例如:1631861379000)
证件类别id_card_typeInt4y证件类别
店铺编号shop_noString20y店铺编号
店铺名称shop_nameString128y店铺名称
店铺备注shop_remarkString255y店铺备注
仓库编号warehouse_noString40y仓库编号
客户姓名customer_nameString40y
客户姓名
客户编码customer_noString40y客户编码
物流名称logistics_nameString40y物流名称
物流公司编号logistics_codeString60y物流公司编号
物流类型logistics_type_nameString6y物流类型名称
送货时间to_deliver_timeString20y送货时间,例如:2020-10-19 00:00:00
预计发货时间delay_to_timeString40y预计发货时间
最晚发货时间

estimate_consign_time

String40y最晚发货时间
店铺id

shop_id

Int6y店铺id
仓库id

warehouse_id

Int6y仓库id
体积

volume

Decimal(19,4)
y体积
订单标签trade_label
String40y订单标签
订单掩码
trade_maskInt11
y

2048:拆分

按位与运算结果不为0则表示符合条件

店铺平台id
shop_platform_idInt4
y店铺平台id
子平台id
sub_platform_idInt4
y子平台id
包装
package_name
String356
y
包装
包装id
package_idInt40
y
包装id
已付
paidDecimal(19,4)
y
已付
订单明细detail_listList<Map<String, Object>>
y
订单明细
detail_list




订单唯一键 trade_idlong
y订单唯一键
订单明细唯一键 rec_idlong
y订单明细唯一键
平台ID platform_idInt4y平台ID
原始子订单号src_oidString40y原始子订单号
原始订单号src_tidString40y原始订单号
是否是赠品gift_typeInt4
y

是否是赠品 0、非赠品

1、自动赠送 2、手工赠送 4、周期购赠送 8、平台赠送

退款状态refund_statusInt4y

退款状态:

0、无退款

1、取消退款

2、申请退款

3、待退款

4、待还原

5、退款成功

6、已退(未付款关闭,未付款的取消了

退款模式guarantee_modeInt4y

退款模式:

1、担保

2、非担保

3、在线非担保

子单平台状态platform_statusInt4
y

如果没有对应的原始单明细,则返回0.

平台状态:

10、未确认

20、待尾款

30、待发货

40、部分发货

50、已发货

60、已签收

70、已完成

80、已退款

90、已关闭

发货条件delivery_termInt4y发货条件:1、款到发货 2、货到付款(包含部分货到付款)

3、分期付款

数量numDecimal(19,4)
y数量
标价
priceDecimal(19,4)
y标价,手工新建时使用货品属性中的“零售价”
售后退款数量refund_numDecimal(19,4)
y售后退款数量
成交价
order_priceDecimal(19,4)
y成交价,原始单折扣及分摊之后的价格
调整后价格share_priceDecimal(19,4)
y进入ERP后再次调整的价格,默认值与order_price一致
手工调整价adjustDecimal(19,4)
y手工调整价,正数为加价,负数为减价,暂未处理
总折扣金额discountDecimal(19,4)
y总折扣金额
分摊后合计应收share_amountDecimal(19,4)
y分摊后合计应收=share_price*num
税率tax_rateDecimal(19,4)
y税率
货品名称goods_nameString255y货品名称
货品编码goods_noString40y货品编码
规格名spec_nameString100y规格名
商家编码spec_noString40y商家编码
规格码spec_codeString40y规格码
组合装商家编码suite_noString40y组合装商家编码
组合装名称suite_nameString255y如果是组合装拆分的,此为组合装名称
组合装数量suite_numDecimal(19,4)
y组合装数量,不受拆分合并影响
组合装分摊后总价suite_amountDecimal(19,4)
y组合装分摊后总价
组合装优惠suite_discount Decimal(19,4)
y组合装优惠
平台货品名称api_goods_nameString255y平台货品名称
平台规格名api_spec_nameString100y平台规格名
平台货品idapi_goods_idString40Y平台货品id
平台规格idapi_spec_idString40Y平台规格id
货品id
goods_idInt11Y货品id(系统货品主键)
单品id
spec_idInt11Y单品id(系统单品主键)
佣金commissionDecimal(19,4)
y佣金
货品类型goods_typeInt4y

货品类型

1销售商品 

2原材料

3包装

4周转材料

5虚拟商品

6固定资产 

0其它

订单内部来源from_maskInt11y订单内部来源: 1、手机

2、聚划算

子单备注remarkString255y子单备注
修改时间modifiedString40y修改时间(毫秒级时间戳,例如:1631861379000)
创建时间createdString40y创建时间(毫秒级时间戳,例如:1631861379000)
自定义属性2prop2String255y自定义属性2
货品重量weightDecimal(19,4)
y货品重量(子单预估货品总重量)
图片路径img_urlString255y图片路径
实发数量
actual_numDecimal(19,4)
y实发数量(订单子单状态变成已取消时,实发数量取0;其他状态时,实发数量=数量)
条码barcodeString50
y条码
已付paidDecimal(19,4)
y已付

5.请求示例

JSON

[{
"start_time": "2020-01-01 00:00:00",
"end_time": "2020-01-20 00:00:00"
}]
PHP
<?php
header("Content-Type: text/html; charset=UTF-8");
date_default_timezone_set("Asia/Shanghai");
require_once('wdtsdk.php');
 
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret");
 
$parMap = new stdClass();
$parMap->start_time = "2020-01-01 00:00:00";
$parMap->end_time = "2020-01-20 00:00:00";
 
$pager = new Pager(1, 0, true);
 
$response = $client->pageCall("sales.TradeQuery.queryWithDetail", $pager, $parMap);
 
?>
JAVA

C#

6.响应示  

 6.1 正常响应示例 

JSON
{
    "status": 0,
    "data": {
        "total_count": 1,
        "order": [{
            "fenxiao_nick": "",
            "post_amount": 0,
            "estimate_consign_time": "",
            "trade_time": 1652043955000,
            "receiver_ring": "",
            "remark_flag": 0,
            "detail_list": [{
                "trade_id": 2443686,
                "platform_id": 127,
                "src_oid": "20220509001",
                "src_tid": "20220509001",
                "gift_type": 0,
                "refund_status": 0,
                "guarantee_mode": 1,
                "delivery_term": 1,
                "num": 1,
                "price": 5,
                "refund_num": 0,
                "order_price": 10,
                "share_price": 10,
                "adjust": 0,
                "discount": -5,
                "share_amount": 10,
                "paid": 0,
                "goods_name": "wangdiantong",
                "tax_rate": 0,
                "goods_no": "wangdiantong",
                "spec_name": "暂无",
                "spec_no": "wangdiantong",
                "spec_code": "LL ",
                "suite_no": "",
                "suite_name": "",
                "suite_num": 0,
                "suite_amount": 0,
                "suite_discount": 0,
                "api_goods_name": "wangdiantong",
                "api_spec_name": "",
                "commission": 0,
                "goods_type": 1,
                "from_mask": 285212672,
                "remark": "",
                "modified": 1672363934000,
                "img_url": "https:\/\/img.alicdn.com\/bao\/uploaded\/i3\/137812952\/O1CN017HEktV1Xg3t9r8B4G_!!137812952.jpg",
                "platform_status": 30,
                "actual_num": 1,
                "created": 1652065788000,
                "prop2": "",
                "weight": 0.2,
                "api_goods_id": "wangdiantong",
                "api_spec_id": "wangdiantong",
                "rec_id": 4928849,
                "pay_status": 2,
                "barcode": "wangdiantong",
                "spec_id": 1,
                "goods_id": 1
            }],
            "bad_reason": 0,
            "discount": -5,
            "pay_account": "",
            "package_id": 163231,
            "raw_goods_count": 1,
            "fchecker_name": "系统",
            "trade_id": 2443686,
            "trade_label": "同名未合并,00-00-sss",
            "checker_name": "系统",
            "refund_status": 0,
            "receiver_province": 120000,
            "buyer_message": "",
            "logistics_code": "20210325",
            "shop_platform_id": 127,
            "trade_mask": 512,
            "src_tids": "20220509001",
            "shop_id": 711,
            "checkouter_name": "系统",
            "id_card_type": 0,
            "freeze_reason": "无",
            "single_spec_no": "wangdiantong",
            "sub_platform_id": 0,
            "goods_count": 1,
            "invoice_content": "",
            "post_cost": 0,
            "receiver_name": "aaaaa",
            "commission": 0,
            "currency": "",
            "trade_from": 1,
            "delivery_term": 1,
            "logistics_no": "",
            "goods_cost": 1.99,
            "receiver_district": 120116,
            "receivable": 10,
            "receiver_mobile": "11111111111",
            "cs_remark": "",
            "receiver_address": "旷世国际111",
            "ext_cod_fee": 0,
            "customer_name": "aaaaa",
            "warehouse_id": 379,
            "logistics_name": "高原原的自有物流",
            "warehouse_type": 2,
            "raw_goods_type_count": 1,
            "receiver_dtb": "天津市 滨海新区",
            "print_remark": "",
            "other_amount": 0,
            "tax_rate": 0,
            "to_deliver_time": "",
            "shop_remark": "",
            "invoice_id": 0,
            "modified": "2022-12-30 09:32:14",
            "shop_no": "wdtapi3-test",
            "receiver_area": "天津 天津市 滨海新区",
            "customer_no": "KH202205090001",
            "created": 1652065788000,
            "weight": 2.2,
            "tax": 0,
            "shop_name": "wdtapi3-test",
            "pay_time": "2022-05-09 05:05:55",
            "volume": 6,
            "trade_no": "JY20220509000003",
            "salesman_name": "系统",
            "receiver_city": 120100,
            "invoice_title": "",
            "goods_type_count": 1,
            "cod_amount": 0,
            "flag_name": "无",
            "receiver_telno": "",
            "receiver_zip": "",
            "warehouse_no": "lztest1",
            "trade_status": 30,
            "invoice_type": 0,
            "profit": 8.01,
            "goods_amount": 5,
            "stockout_no": "",
            "version_id": 2,
            "buyer_nick": "aaaaa",
            "fenxiao_type": 0,
            "platform_id": 127,
            "package_name": "lzx包装(lzx包装1)",
            "paid": 0,
            "trade_type": 1,
            "logistics_type_name": "自有物流",
            "delay_to_time": ""
        }]
    }
}

   6.2 异常响应示例

JSON
{"status":100,"message":"您的查询时间过宽,查询时间不能大于60分钟"}



常用工具